deleteCustomerAddress mutation

data-variant=warning

data-slots=text

Use the deleteCustomerAddress mutation to delete the specified customer address. It returns a Boolean value that indicates whether the operation was successful.

We recommend you use a customer token in the header of your call to delete a customer. However, you also can use session authentication.

Syntax

mutation {
  deleteCustomerAddress(
    id: Int!
  ) {
    Boolean
  }
}

Reference

The deleteCustomerAddress reference provides detailed information about the types and fields defined in this mutation.

• Adobe Commerce as a Cloud Service

• On-Premises/Cloud

Example usage

The following call deletes a customer's address.

Request:

mutation {
  deleteCustomerAddress(id: 4)
}

Response:

{
  "data": {
    "deleteCustomerAddress": true
  }
}

Input attributes

The deleteCustomerAddress mutation requires the following input:

Output attributes

The deleteCustomerAddress mutation returns a Boolean value that indicates whether the operation was successful.

Errors

Related topics

• customer query
• createCustomer mutation
• updateCustomer mutation
• createCustomerAddress mutation
• updateCustomerAddress mutation