Anchor to section titled 'undefined'

customerAddressCreate
mutation

Requires unauthenticated_write_customers access scope.

Creates a new address for a customer.

Anchor to section titled 'Arguments'

Arguments

Anchor to address
address
MailingAddressInput!
required

The customer mailing address to create.

Anchor to customerAccessToken
customerAccessToken
String!
required

The access token used to identify the customer.

Was this section helpful?
Anchor to section titled 'CustomerAddressCreatePayload returns'

CustomerAddressCreatePayload returns

Anchor to CustomerAddressCreatePayload.customerAddress
customerAddress
MailingAddress

The new customer address object.

Anchor to CustomerAddressCreatePayload.customerUserErrors
customerUserErrors
[CustomerUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Anchor to CustomerAddressCreatePayload.userErrors
userErrors
[UserError!]!
non-null
deprecated

The list of errors that occurred from executing the mutation. Use customerUserErrors instead.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation customerAddressCreate($address: MailingAddressInput!, $customerAccessToken: String!) {
  customerAddressCreate(address: $address, customerAccessToken: $customerAccessToken) {
    customerAddress {
      # MailingAddress fields
    }
    customerUserErrors {
      # CustomerUserError fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "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
}