Mailing
A physical mailing address. For example, a Customer's default address and an Order's billing address are both mailing addresses. Stores standard address components, customer name information, and company details.
The address includes geographic coordinates (latitude and longitude). You can format addresses for display using the formatted field with options to include or exclude name and company information.
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!
Validated non-null 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 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.
- 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•String
Code Deprecated
Anchor to MutationsMutations
- •mutation
Creates a new
for aCustomer. You can optionally set the address as the customer's default address.You can only add addresses to existing customers. Each customer can have multiple addresses.
- •mutation
Updates a
Customer's. You can modify any field of the address and optionally set it as the customer's default address.