For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.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
- Overview

GraphQL Storefront Mutations

deleteCustomerAddress

Example Query

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

Variables

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

Example response

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

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.