customerAddressUpdate

mutation

Requires write_customers access scope.

Update a customer's address information.

Arguments

Anchor to addressaddress • MailingAddressInput!required: Specifies the fields to use when updating the address.
Anchor to addressIdaddressId • ID!required: The ID of the address to update.
Anchor to customerIdcustomerId • ID!required: The ID of the customer whose address is being updated.
Anchor to setAsDefaultsetAsDefault • Boolean: Whether to set the address as the customer's default address.

Was this section helpful?

Anchor to CustomerAddressUpdatePayload returnsCustomerAddressUpdatePayload returns

Anchor to addressaddress • MailingAddress: The updated address.
Anchor to userErrorsuserErrors • [UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation customerAddressUpdate($address: MailingAddressInput!, $addressId: ID!, $customerId: ID!, $setAsDefault: Boolean) {
2  customerAddressUpdate(address: $address, addressId: $addressId, customerId: $customerId, setAsDefault: $setAsDefault) {
3    address {
4      # MailingAddress fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

1{
2  "address": {
3    "address1": "<your-address1>",
4    "address2": "<your-address2>",
5    "city": "<your-city>",
6    "company": "<your-company>",
7    "countryCode": "",
8    "firstName": "<your-firstName>",
9    "lastName": "<your-lastName>",
10    "phone": "<your-phone>",
11    "provinceCode": "<your-provinceCode>",
12    "zip": "<your-zip>"
13  },
14  "addressId": "gid://shopify/<objectName>/10079785100",
15  "customerId": "gid://shopify/<objectName>/10079785100",
16  "setAsDefault": true
17}

{
  "address": {
    "address1": "<your-address1>",
    "address2": "<your-address2>",
    "city": "<your-city>",
    "company": "<your-company>",
    "countryCode": "",
    "firstName": "<your-firstName>",
    "lastName": "<your-lastName>",
    "phone": "<your-phone>",
    "provinceCode": "<your-provinceCode>",
    "zip": "<your-zip>"
  },
  "addressId": "gid://shopify/<objectName>/10079785100",
  "customerId": "gid://shopify/<objectName>/10079785100",
  "setAsDefault": true
}

input MailingAddressInput {
  address1: String
  address2: String
  city: String
  company: String
  country: String
  countryCode: CountryCode
  firstName: String
  id: ID
  lastName: String
  phone: String
  province: String
  provinceCode: String
  zip: String
}