Skip to main content

Delete Customer Address

DELETE 

/api/customers/:customer/addresses/:address

Remove an address from a customer's address book. If the removed address was the customer's default shipping or billing address, the most recently added remaining address is automatically promoted as the new default (or the default is cleared when no other address exists). The underlying address record is permanently deleted only when no other records (other customers, sales orders, etc.) still reference it; otherwise only the customer's link to it is removed.

Required scope: customers:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Returns the customer's refreshed address book.

Authentication: Requires Bearer token with the customers read/write scope.

Request

Responses

OK

Response Headers
    Content-Type