MailingAddress

object

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 coordinatesValidatedcoordinatesValidated • Boolean!non-null: Whether the address corresponds to recognized latitude and longitude values.
Anchor to countrycountry • String: The name of the country.
Anchor to countryCodeV2countryCodeV2 • CountryCode: The two-letter code for the country of the address.

For example, US.
Anchor to firstNamefirstName • String: 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 formattedAreaformattedArea • String: A comma-separated list of the values for city, province, and country.
Anchor to idid • ID!non-null: A globally-unique ID.
Anchor to lastNamelastName • String: 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 provinceCodeprovinceCode • String: The alphanumeric code for the region.

For example, ON.
Anchor to timeZonetimeZone • String: The time zone of the address.
Anchor to validationResultSummaryvalidationResultSummary • MailingAddressValidationResult: 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.
Anchor to zipzip • String: The zip or postal code of the address.
Anchor to countryCodecountryCode • StringDeprecated: The two-letter code for the country of the address.

For example, US. Use countryCodeV2 instead.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to Node Node • interface

Was this section helpful?