Skip to content
agovena.
agovena.
Get started
Community

API overview

Delete an owned address

Choose an operation to see its request, response shape, access rules and implementation source.

WriteAuthenticated

DELETE/api/v1/addresses/{address}

Delete an owned address

Sanctum session or bearer token. Required bearer ability: addresses.delete

Request
FieldInRule
addressPath parameterRequired numeric ID owned by the authenticated customer. Foreign and missing IDs return 404.

No request body.

cURL
curl --request DELETE "https://shop.example.test/api/v1/addresses/$ADDRESS_ID" \
  --header 'Accept: application/json' \
  --header "Authorization: Bearer $API_TOKEN"
Response200
Success: 200

Response shape (notation, not a captured response)

schema
{ "ok": true }

Full response schema

Common errors
HTTP statusMeaning
401unauthenticated: missing or invalid authentication.
403unauthorized, insufficient_scope or ip_not_allowed: check account context, required ability and token IP policy.
404not_found: missing, inactive or foreign-owned resource.
429rate_limited: back off before retrying, especially writes.
Error envelope and global caveats

Search documentation

Search guides, commands and API endpoints

What are you looking for?

Documentation