Company Address
Requires access scope or
access scope. Also: The API client must be installed on a Shopify Plus store.
Represents a billing or shipping address for a company location.
Anchor to FieldsFields
- Anchor to address1address1•String!non-null
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 companyNamecompany•String!non-null
Name The name of the company.
- Anchor to countrycountry•String
The name of the country.
- Anchor to countryCodecountry•Country
Code Code!non-null The two-letter code for the country of the address. For example, US.
- Anchor to createdAtcreated•Date
At Time!non-null The date and time (ISO 8601 format) at which the company address was created.
- Anchor to firstNamefirst•String
Name The first name of the recipient.
- Anchor to formattedAddressformatted•[String!]!non-null
Address The formatted version of the address.
- 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 recipient.
- Anchor to phonephone•String
A unique phone number for the customer. Formatted using E.164 standard. For example, +16135551111.
- Anchor to provinceprovince•String
The region of the address, such as the province, state, or district.
- Anchor to recipientrecipient•String
The identity of the recipient e.g. 'Receiving Department'.
- Anchor to updatedAtupdated•Date
At Time!non-null The date and time (ISO 8601 format) at which the company address was last updated.
- •String
The zip or postal code of the address.
- Anchor to zoneCodezone•String
Code The alphanumeric code for the region. For example, ON.
Anchor to MutationsMutations
- •mutation
Updates an address on a company location.
- Anchor to addressaddress•Company
Address Input!required The input fields to use to update the address.
- Anchor to addressTypesaddress•[Company
Types Address Type!]!required The list of address types on the location to update.
- Anchor to locationIdlocation•ID!required
Id The ID of the company location to update addresses on.
Arguments
- Anchor to addressesaddresses•[Company
Address!] The list of updated addresses on the company location.
- Anchor to userErrorsuser•[Business
Errors Customer User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields