CompanyAddress - admin-graphql - OBJECT
Version: 2025-01
Description:
Represents a billing or shipping address for a company location.
Access Scopes
`read_customers` access scope or `read_companies` access scope. Also: The API client must be installed on a Shopify Plus store.
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.
-
companyName:
String! -
The name of the company.
-
country:
String -
The name of the country.
-
countryCode:
CountryCode! -
The two-letter code for the country of the address.
For example, US.
-
createdAt:
DateTime! -
The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company address was created.
-
firstName:
String -
The first name of the recipient.
-
formattedAddress:
String! -
The formatted version of the address.
-
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 recipient.
-
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.
-
recipient:
String -
The identity of the recipient e.g. 'Receiving Department'.
-
updatedAt:
DateTime! -
The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company address was last updated.
-
zip:
String -
The zip or postal code of the address.
-
zoneCode:
String -
The alphanumeric code for the region.
For example, ON.
Connections
Related queries
Related mutations
Related Unions
Examples
