Skip to main content
Anchor to customerAddressUpdate

customerAddressUpdate

mutation

Requires write_customers access scope.

Updates a Customer's MailingAddress. You can modify any field of the address and optionally set it as the customer's default address.

•MailingAddressInput!
required

Specifies the fields to use when updating the address.

Show input fields
•ID!
required

The ID of the address to update.

•ID!
required

The ID of the customer whose address is being updated.

•Boolean

Whether to set the address as the customer's default address.


Was this section helpful?

Anchor to CustomerAddressUpdatePayload returnsCustomerAddressUpdatePayload returns

•MailingAddress

The updated address.

Show fields
•[UserError!]!
non-null

The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?