customerAddressDelete mutation

Permanently deletes the address of an existing customer.

Required access

unauthenticated_write_customers access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

customerAccessToken ( String! ) required

The access token used to identify the customer.

id ( ID! ) required

Specifies the address to delete.

Return fields

customerUserErrors ([CustomerUserError!]!)

List of errors that occurred executing the mutation.

deletedCustomerAddressId (String)

ID of the deleted customer address.

Deprecated return fields

userErrors ([UserError!]!) deprecated

List of errors that occurred executing the mutation.

Deprecation warning

Use customerUserErrors instead

Permanently deletes the address of an existing customer.

Required access

unauthenticated_write_customers access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

customerAccessToken ( String! ) required

The access token used to identify the customer.

id ( ID! ) required

Specifies the address to delete.

Return fields

customerUserErrors ([CustomerUserError!]!)

List of errors that occurred executing the mutation.

deletedCustomerAddressId (String)

ID of the deleted customer address.

Deprecated return fields

userErrors ([UserError!]!) deprecated

List of errors that occurred executing the mutation.

Deprecation warning

Use customerUserErrors instead

Permanently deletes the address of an existing customer.

Required access

unauthenticated_write_customers access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

customerAccessToken ( String! ) required

The access token used to identify the customer.

id ( ID! ) required

Specifies the address to delete.

Return fields

customerUserErrors ([CustomerUserError!]!)

List of errors that occurred executing the mutation.

deletedCustomerAddressId (String)

ID of the deleted customer address.

Deprecated return fields

userErrors ([UserError!]!) deprecated

List of errors that occurred executing the mutation.

Deprecation warning

Use customerUserErrors instead

Permanently deletes the address of an existing customer.

Required access

unauthenticated_write_customers access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

customerAccessToken ( String! ) required

The access token used to identify the customer.

id ( ID! ) required

Specifies the address to delete.

Return fields

customerUserErrors ([CustomerUserError!]!)

List of errors that occurred executing the mutation.

deletedCustomerAddressId (String)

ID of the deleted customer address.

Deprecated return fields

userErrors ([UserError!]!) deprecated

List of errors that occurred executing the mutation.

Deprecation warning

Use customerUserErrors instead

Permanently deletes the address of an existing customer.

Required access

unauthenticated_write_customers access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

customerAccessToken ( String! ) required

The access token used to identify the customer.

id ( ID! ) required

Specifies the address to delete.

Return fields

customerUserErrors ([CustomerUserError!]!)

List of errors that occurred executing the mutation.

deletedCustomerAddressId (String)

ID of the deleted customer address.

Deprecated return fields

userErrors ([UserError!]!) deprecated

List of errors that occurred executing the mutation.

Deprecation warning

Use customerUserErrors instead