customerDefaultAddressUpdate mutation

Updates the default 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

addressId ( ID! ) required

ID of the address to set as the new default for the customer.

customerAccessToken ( String! ) required

The access token used to identify the customer.

Return fields

customer (Customer)

The updated customer object.

customerUserErrors ([CustomerUserError!]!)

List of errors that occurred executing the mutation.

Deprecated return fields

Show/Hide
userErrors ([UserError!]!) deprecated

List of errors that occurred executing the mutation.

Deprecation warning

Use customerUserErrors instead

Updates the default 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

addressId ( ID! ) required

ID of the address to set as the new default for the customer.

customerAccessToken ( String! ) required

The access token used to identify the customer.

Return fields

customer (Customer)

The updated customer object.

customerUserErrors ([CustomerUserError!]!)

List of errors that occurred executing the mutation.

Deprecated return fields

Show/Hide
userErrors ([UserError!]!) deprecated

List of errors that occurred executing the mutation.

Deprecation warning

Use customerUserErrors instead

Updates the default 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

addressId ( ID! ) required

ID of the address to set as the new default for the customer.

customerAccessToken ( String! ) required

The access token used to identify the customer.

Return fields

customer (Customer)

The updated customer object.

customerUserErrors ([CustomerUserError!]!)

List of errors that occurred executing the mutation.

Deprecated return fields

Show/Hide
userErrors ([UserError!]!) deprecated

List of errors that occurred executing the mutation.

Deprecation warning

Use customerUserErrors instead

Sign up for a Partner account to get started.

Sign up