Choose a version:

customerAddressCreate

mutation

Creates a new address for a customer.

Arguments

Anchor to addressaddress •CustomerAddressInput!required: Specifies the fields to use when creating the address.
Anchor to defaultAddressdefaultAddress •BooleanDefault:false: The flag to set the address as the default address.

Was this section helpful?

Anchor to CustomerAddressCreatePayload returnsCustomerAddressCreatePayload returns

Anchor to customerAddresscustomerAddress •CustomerAddress: The created customer address.
Anchor to userErrorsuserErrors •[UserErrorsCustomerAddressUserErrors!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

mutation customerAddressCreate($address: CustomerAddressInput!, $defaultAddress: Boolean) {

customerAddressCreate(address: $address, defaultAddress: $defaultAddress) {

customerAddress {

# CustomerAddress fields

}

userErrors {

field

message

}

Input

{

"address": {

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

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

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

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

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

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

"phoneNumber": "<your-phoneNumber>",

"territoryCode": "<your-territoryCode>",

"zip": "<your-zip>",

"zoneCode": "<your-zoneCode>"

"defaultAddress": true

}

{
  "address": {
    "address1": "<your-address1>",
    "address2": "<your-address2>",
    "city": "<your-city>",
    "company": "<your-company>",
    "firstName": "<your-firstName>",
    "lastName": "<your-lastName>",
    "phoneNumber": "<your-phoneNumber>",
    "territoryCode": "<your-territoryCode>",
    "zip": "<your-zip>",
    "zoneCode": "<your-zoneCode>"
  },
  "defaultAddress": true
}

input CustomerAddressInput {
  address1: String
  address2: String
  city: String
  company: String
  firstName: String
  lastName: String
  phoneNumber: String
  territoryCode: String
  zip: String
  zoneCode: String
}