Choose a version:

customerAddressCreate

mutation

Requires unauthenticated_write_customers access scope.

Creates a new MailingAddress for a Customer. Use the customer's access token to identify them. Successful creation returns the new address.

Each customer can have multiple addresses.

Anchor to Arguments

Arguments

Anchor to addressaddress

•MailingAddressInput!

required

The customer mailing address to create.

Show input fields

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.

Show fields
Anchor to customerUserErrorscustomerUserErrors •[CustomerUserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields
Anchor to userErrorsuserErrors •[UserError!]! non-nullDeprecated: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

customerAddressCreate reference

Mutation Reference

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

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

customerAddress {

# MailingAddress fields

}

customerUserErrors {

# CustomerUserError fields

}

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

}

Variables

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

Schema

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