Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleCompanies / Locations

The list of locations in the company.

Field

Description

Created at

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

Currency

The location's currency based on the shipping address. If the shipping address is empty, then the value is the shop's primary market.

Default cursor

A default cursor that returns the single next record, sorted ascending by ID.

External id

A unique externally-supplied ID for the company location.

Has timeline comment

Whether the merchant added a timeline comment to the company location

ID

Globally unique ID.

Locale

The preferred locale of the company location.

Name

The name of the company location.

Note

A note about the company location.

Orders count

The total number of orders placed for this company, across all its locations.

Orders count precision

Precision of orders count, how exact is the value.

Phone

The phone number of the company location.

Tax registration ID

The tax registration ID for the company location.

Updated at

The date and time (ISO 8601 format) at which the company location was last modified.

Expand
titleCompanies / Locations / Metafields

List of metafields that belong to the resource.

Field

Description

Description

The description of a metafield.

Key

The key name for a metafield.

Legacy resource ID

The ID of the corresponding resource in the REST Admin API.

Metafield ID

Globally unique ID.

Namespace

The namespace for a metafield.

Owner type

Owner type of a metafield visible to the Storefront API.

Type

The type of data that the metafield stores in the value field.

Value

The value of a metafield.

Expand
titleCompanies / Main contact

The main contact for the company.

Field

Description

Created at

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

ID

Globally unique ID.

Is main contact

Whether the contact is the main contact of the company.

Lifetime duration

The lifetime duration of the company contact, since its creation date on Shopify. Examples: 1 year, 2 months, 3 days.

Locale

The company contact's locale (language).

Title

The company contact's job title.

Updated at

The date and time (ISO 8601 format) at which the company contact was last updated.

...