Choose a version:

customerAddressUpdate

mutation

Requires unauthenticated_write_customers access scope.

Updates an existing MailingAddress for a Customer. Requires a customer access token to identify the customer, an ID to specify which address to modify, and an address with the updated fields.

Successful update returns the updated MailingAddress.

Anchor to Arguments

Arguments

Anchor to addressaddress

•MailingAddressInput!

required

The customer’s mailing address.

Anchor to customerAccessTokencustomerAccessToken

•String!

required

The access token used to identify the customer.

Anchor to idid

•ID!

required

Specifies the customer address to update.

Was this section helpful?

Anchor to CustomerAddressUpdatePayload returnsCustomerAddressUpdatePayload returns

Anchor to customerAddresscustomerAddress •MailingAddress: The customer’s updated mailing address.
Anchor to customerUserErrorscustomerUserErrors •[CustomerUserError!]! non-null: The list of errors that occurred from executing the mutation.
Anchor to userErrorsuserErrors •[UserError!]! non-nullDeprecated: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

customerAddressUpdate reference

Mutation Reference

mutation customerAddressUpdate($customerAccessToken: String!, $id: ID!, $address: MailingAddressInput!) {

customerAddressUpdate(customerAccessToken: $customerAccessToken, id: $id, address: $address) {

customerAddress {

# MailingAddress fields

}

customerUserErrors {

# CustomerUserError fields

}

Input

{

"customerAccessToken": "<your-customerAccessToken>",

"id": "gid://shopify/<objectName>/10079785100",

"address": {

"address1": "<your-address1>",

"address2": "<your-address2>",

"city": "<your-city>",

"company": "<your-company>",

"country": "<your-country>",

"firstName": "<your-firstName>",

"lastName": "<your-lastName>",

"phone": "<your-phone>",

"province": "<your-province>",

"zip": "<your-zip>"

}

Variables

{
  "customerAccessToken": "<your-customerAccessToken>",
  "id": "gid://shopify/<objectName>/10079785100",
  "address": {
    "address1": "<your-address1>",
    "address2": "<your-address2>",
    "city": "<your-city>",
    "company": "<your-company>",
    "country": "<your-country>",
    "firstName": "<your-firstName>",
    "lastName": "<your-lastName>",
    "phone": "<your-phone>",
    "province": "<your-province>",
    "zip": "<your-zip>"
  }
}

Schema

input MailingAddressInput {
  address1: String
  address2: String
  city: String
  company: String
  country: String
  firstName: String
  lastName: String
  phone: String
  province: String
  zip: String
}