API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

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

Argument Description
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

  • 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

Argument Description
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

  • 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

Argument Description
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

  • 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

Argument Description
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

  • 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

Argument Description
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

  • 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

Argument Description
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

  • 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

Argument Description
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

  • 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

Argument Description
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

  • 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

Argument Description
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

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use customerUserErrors instead