For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Docs API Reference Learn Community Changelog

Docs API Reference Learn Community Changelog

- About Our APIs
REST
GraphQL
MCP

GraphQL Storefront Mutations

deleteCustomerAddress

Example Query

1 mutation ExampleMutation($reCaptchaV2: ReCaptchaV2Input, $input: DeleteCustomerAddressInput!) {
2   customer {
3     deleteCustomerAddress(reCaptchaV2: $reCaptchaV2, input: $input) {
4       errors
5     }
6   }
7 }

Variables

1 {
2   "reCaptchaV2": {
3     "token": "example"
4   },
5   "input": {
6     "addressEntityId": 0
7   }
8 }

Example response

1 {
2   "data": {
3     "customer": {
4       "deleteCustomerAddress": {
5         "errors": [
6           {
7             "message": "example"
8           }
9         ]
10       }
11     }
12   }
13 }

Delete a customer address.

Was this page helpful?

updateCustomerAddress

payment

Arguments

reCaptchaV2ReCaptchaV2InputOptional

Recaptcha token.

inputDeleteCustomerAddressInputRequired

Input for deleting a customer address.

Returns

a DeleteCustomerAddressResult

errorslist of DeleteCustomerAddressErrors

Response errors that occurred while attempting to delete a customer address.