Skip to content

Delete Customer Address (GraphQL)

Removes an address from a customer's address book. customerId is required and must own the address — omitting it or passing a different customer returns errors[]. On success the deleted record is no longer addressable, so the adminCustomerAddress payload comes back null.

Permission: customers.addresses.delete.

Menu overview

See the Customer Addresses overview for the full address-book flow.

Prerequisites

The example uses an illustrative id value. Replace it with the id of a customer address that exists in your store — use the adminCustomerAddresses query to discover valid ids.

Released under the MIT License.