Skip to main content
object

Requires read_customers access scope or read_companies access scope. Also: The API client must be installed on a Shopify Plus store.

Represents a billing or shipping address for a company location.

String!non-null

The first line of the address. Typically the street address or PO Box number.

String

The second line of the address. Typically the number of the apartment, suite, or unit.

String

The name of the city, district, village, or town.

String!non-null

The name of the company.

String

The name of the country.

CountryCode!non-null

The two-letter code for the country of the address. For example, US.

DateTime!non-null

The date and time (ISO 8601 format) at which the company address was created.

String

The first name of the recipient.

[String!]!non-null

The formatted version of the address.

String

A comma-separated list of the values for city, province, and country.

ID!non-null

A globally-unique ID.

String

The last name of the recipient.

String

A unique phone number for the customer. Formatted using E.164 standard. For example, +16135551111.

String

The region of the address, such as the province, state, or district.

String

The identity of the recipient e.g. 'Receiving Department'.

DateTime!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.

String

The alphanumeric code for the region. For example, ON.


Was this section helpful?

mutation

Updates an address on a company location.

Arguments

CompanyAddressInput!required

The input fields to use to update the address.

[CompanyAddressType!]!required

The list of address types on the location to update.

ID!required

The ID of the company location to update addresses on.


Fields

[CompanyAddress!]

The list of updated addresses on the company location.

[BusinessCustomerUserError!]!non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?

interface

Was this section helpful?
OSZAR »