Choose a version:

customerAddressCreate

mutation

Requires unauthenticated_write_customers access scope.

Creates a new address for a customer.

Arguments

Anchor to addressaddress •MailingAddressInput! required: The customer mailing address to create.
Anchor to customerAccessTokencustomerAccessToken •String! required: The access token used to identify the customer.

Was this section helpful?

Anchor to CustomerAddressCreatePayload returnsCustomerAddressCreatePayload returns

Anchor to customerAddresscustomerAddress •MailingAddress: The new customer address object.
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?

Mutation Reference

mutation customerAddressCreate($address: MailingAddressInput!, $customerAccessToken: String!) {

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

customerAddress {

# MailingAddress fields

}

customerUserErrors {

# CustomerUserError fields

}

userErrors {

field

message

}

Input

{

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

"customerAccessToken": "<your-customerAccessToken>"

}

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

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