Choose a version:

customerAddressDelete

mutation

Requires unauthenticated_write_customers access scope.

Permanently deletes a specific MailingAddress for a Customer. Requires a valid customer access token to authenticate the request.

Caution

This action is irreversible. You can't recover the deleted address.

Arguments

Anchor to customerAccessTokencustomerAccessToken •String! required: The access token used to identify the customer.
Anchor to idid •ID! required: Specifies the address to delete.

Was this section helpful?

Anchor to customerUserErrorscustomerUserErrors •[CustomerUserError!]! non-null: The list of errors that occurred from executing the mutation.
Anchor to deletedCustomerAddressIddeletedCustomerAddressId •String: ID of the deleted customer address.
Anchor to userErrorsuserErrors •[UserError!]! non-nullDeprecated: The list of errors that occurred from executing the mutation.

Was this section helpful?

mutation customerAddressDelete($id: ID!, $customerAccessToken: String!) {

customerAddressDelete(id: $id, customerAccessToken: $customerAccessToken) {

customerUserErrors {

# CustomerUserError fields

}

deletedCustomerAddressId

}

{

"id": "gid://shopify/<objectName>/10079785100",

"customerAccessToken": "<your-customerAccessToken>"

}