Mailing
Represents a mailing address for customers and shipping.
Anchor to FieldsFields
- Anchor to address1address1•String
The first line of the address. Typically the street address or PO Box number.
- Anchor to address2address2•String
The second line of the address. Typically the number of the apartment, suite, or unit.
- Anchor to citycity•String
The name of the city, district, village, or town.
- Anchor to companycompany•String
The name of the customer's company or organization.
- Anchor to countrycountry•String
The name of the country.
- Anchor to countryCodeV2country•Country
Code V2 Code The two-letter code for the country of the address.
For example, US.
- Anchor to firstNamefirst•String
Name The first name of the customer.
- Anchor to formattedformatted•[String!]!non-null
A formatted version of the address, customized by the provided arguments.
- Anchor to withNamewith•Boolean
Name Default:false Whether to include the customer's name in the formatted address.
- Anchor to withCompanywith•Boolean
Company Default:true Whether to include the customer's company in the formatted address.
Arguments
- Anchor to formattedAreaformatted•String
Area A comma-separated list of the values for city, province, and country.
- •ID!non-null
A globally-unique ID.
- Anchor to lastNamelast•String
Name The last name of the customer.
- Anchor to latitudelatitude•Float
The latitude coordinate of the customer address.
- Anchor to longitudelongitude•Float
The longitude coordinate of the customer address.
- Anchor to namename•String
The full name of the customer, based on firstName and lastName.
- Anchor to phonephone•String
A unique phone number for the customer.
Formatted using E.164 standard. For example, +16135551111.
- Anchor to provinceprovince•String
The region of the address, such as the province, state, or district.
- Anchor to provinceCodeprovince•String
Code The alphanumeric code for the region.
For example, ON.
- •String
The zip or postal code of the address.
- Anchor to countryCodecountry•String
Code Deprecated
Anchor to MutationsMutations
- •mutation
Creates a new address for a customer.
- Anchor to addressaddress•Mailing
Address Input! required The customer mailing address to create.
- Anchor to customerAccessTokencustomer•String!
Access Token required The access token used to identify the customer.
Arguments
- Anchor to customerAddresscustomer•Mailing
Address Address The new customer address object.
- Anchor to customerUserErrorscustomer•[Customer
User Errors User Error!]! non-null The list of errors that occurred from executing the mutation.
- Anchor to userErrorsuser•[User
Errors Error!]! non-nullDeprecated
Fields
- •mutation
Updates the address of an existing customer.
- Anchor to addressaddress•Mailing
Address Input! required The customer’s mailing address.
- Anchor to customerAccessTokencustomer•String!
Access Token required The access token used to identify the customer.
- •ID!required
Specifies the customer address to update.
Arguments
- Anchor to customerAddresscustomer•Mailing
Address Address The customer’s updated mailing address.
- Anchor to customerUserErrorscustomer•[Customer
User Errors User Error!]! non-null The list of errors that occurred from executing the mutation.
- Anchor to userErrorsuser•[User
Errors Error!]! non-nullDeprecated
Fields