customerAddressCreate

mutation

Requires write_customers access scope.

Create a new customer address.

Arguments

Anchor to addressaddress • MailingAddressInput!required: Specifies the fields to use when creating the address.
Anchor to customerIdcustomerId • ID!required: The ID of the customer.
Anchor to setAsDefaultsetAsDefault • Boolean: Whether to set the address as the customer's default address.

Was this section helpful?

Anchor to CustomerAddressCreatePayload returnsCustomerAddressCreatePayload returns

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

Was this section helpful?

Mutation Reference

mutation customerAddressCreate($address: MailingAddressInput!, $customerId: ID!, $setAsDefault: Boolean) {

customerAddressCreate(address: $address, customerId: $customerId, setAsDefault: $setAsDefault) {

address {

# MailingAddress fields

}

userErrors {

field

message

}

Input

{

"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>"

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

"setAsDefault": true

}

{
  "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>"
  },
  "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
}