MailingAddress - admin-graphql - OBJECT
Version: 2024-07
Description:
Represents a customer mailing address.
For example, a customer's default address and an order's billing address are both mailling addresses.
Access Scopes
Fields
address1 :
String -
The first line of the address. Typically the street address or PO Box number.
address2 :
String -
The second line of the address. Typically the number of the apartment, suite, or unit.
city :
String -
The name of the city, district, village, or town.
company :
String -
The name of the customer's company or organization.
coordinatesValidated :
Boolean! -
Whether the address coordinates are valid.
country :
String -
The name of the country.
countryCode :
String -
The two-letter code for the country of the address.
For example, US.
countryCodeV2 :
CountryCode -
The two-letter code for the country of the address.
For example, US.
firstName :
String -
The first name of the customer.
formatted :
String! -
A formatted version of the address, customized by the provided arguments.
formattedArea :
String -
A comma-separated list of the values for city, province, and country.
id :
ID! -
A globally-unique ID.
lastName :
String -
The last name of the customer.
latitude :
Float -
The latitude coordinate of the customer address.
longitude :
Float -
The longitude coordinate of the customer address.
name :
String -
The full name of the customer, based on firstName and lastName.
phone :
String -
A unique phone number for the customer.
province :
String -
The region of the address, such as the province, state, or district.
provinceCode :
String -
The alphanumeric code for the region.
For example, ON.
timeZone :
String -
The time zone of the address.
validationResultSummary :
MailingAddressValidationResult -
Represents the state of validation of a mailing address. For more information, refer to [Validating shipping addresses on your orders](https://help.shopify.com/manual/orders/manage-orders/shipping-address-validation).
zip :
String -
The zip or postal code of the address.
Connections
Related queries
Related mutations
Related Unions
Examples