MailingAddress - storefront - OBJECT
Version: 2025-01
Description:
Represents a mailing address for customers and shipping.
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.
-
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.
Formatted using E.164 standard. For example, _+16135551111_.
-
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.
-
zip:
String -
The zip or postal code of the address.
Connections
Related queries
Related mutations
Related Unions
-
DeliveryAddress
A delivery address of the buyer that is interacting with the cart.
Examples
