Skip to content

Delete an address

DELETE
/tenant/stores/{storeRef}/customers/address/{addressId}
curl --request DELETE \
--url https://apibase.ecomweb.app/api/v1/tenant/stores/example/customers/address/1 \
--header 'Authorization: Bearer <token>' \
--header 'x-storefront-api-key: <x-storefront-api-key>'

Deletes a saved address of the signed-in shopper. Returns 403 when the address belongs to another customer and 404 when it does not exist.

addressId
required
number

The address ID, as returned when the address was created or listed.

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
success
required

Always true.

boolean

Example

{
"success": true
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The resource does not exist in this store.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}