Mailing
Represents a customer mailing address.
For example, a customer's default address and an order's billing address are both mailling addresses.
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 coordinatesValidatedcoordinates•Boolean!non-null
Validated Whether the address corresponds to recognized latitude and longitude values.
- 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 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.
- 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.
- Anchor to timeZonetime•String
Zone The time zone of the address.
- Anchor to validationResultSummaryvalidation•Mailing
Result Summary Address Validation Result The validation status that is leveraged by the address validation feature in the Shopify Admin. See "Validating addresses in your Shopify admin" for more details.
- •String
The zip or postal code of the address.
- Anchor to countryCodecountry•StringDeprecated
Code
Anchor to MutationsMutations
- •mutation
Create a new customer address.
- Anchor to addressaddress•Mailing
Address Input!required Specifies the fields to use when creating the address.
- Anchor to customerIdcustomer•ID!required
Id The ID of the customer.
- Anchor to setAsDefaultset•Boolean
As Default Whether to set the address as the customer's default address.
Arguments
- Anchor to addressaddress•Mailing
Address The created address.
- Anchor to userErrorsuser•[User
Errors Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Update a customer's address information.
- Anchor to addressaddress•Mailing
Address Input!required Specifies the fields to use when updating the address.
- Anchor to addressIdaddress•ID!required
Id The ID of the address to update.
- Anchor to customerIdcustomer•ID!required
Id The ID of the customer whose address is being updated.
- Anchor to setAsDefaultset•Boolean
As Default Whether to set the address as the customer's default address.
Arguments
- Anchor to addressaddress•Mailing
Address The updated address.
- Anchor to userErrorsuser•[User
Errors Error!]!non-null The list of errors that occurred from executing the mutation.
Fields