Anchor to section titled 'undefined'

customerAddressDelete
mutation

Requires unauthenticated_write_customers access scope.

Permanently deletes the address of an existing customer.

Anchor to section titled 'Arguments'

Arguments

Anchor to customerAccessToken
customerAccessToken
String!
required

The access token used to identify the customer.

Anchor to id
id
ID!
required

Specifies the address to delete.

Was this section helpful?
Anchor to section titled 'CustomerAddressDeletePayload returns'

CustomerAddressDeletePayload returns

Anchor to CustomerAddressDeletePayload.customerUserErrors
customerUserErrors
[CustomerUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Anchor to CustomerAddressDeletePayload.deletedCustomerAddressId
deletedCustomerAddressId
String

ID of the deleted customer address.

Anchor to CustomerAddressDeletePayload.userErrors
userErrors
[UserError!]!
non-null
deprecated

The list of errors that occurred from executing the mutation. Use customerUserErrors instead.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation customerAddressDelete($customerAccessToken: String!, $id: ID!) {
  customerAddressDelete(customerAccessToken: $customerAccessToken, id: $id) {
    customerUserErrors {
      # CustomerUserError fields
    }
    deletedCustomerAddressId
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "customerAccessToken": "<your-customerAccessToken>",
  "id": "gid://shopify/<objectName>/10079785100"
}