Companies

Field	Description
Contact count	The number of contacts that belong to the company.
Created at	The date and time (ISO 8601 format) at which the company was created in Shopify.
Customer since	The date and time (ISO 8601 format) at which the company became the customer.
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.
Has timeline comment	Whether the merchant added a timeline comment to the company.
ID	Globally unique ID.
Lifetime duration	The lifetime duration of the company, since it became a customer of the shop. Examples: 2 days, 3 months, 1 year.
Location count	The number of locations that belong to the company.
Name	The name of the company.
Note	A note about the company.
Order count	The total number of orders placed for this company, across all its locations.
Updated at	The date and time (ISO 8601 format) at which the company was last modified.

Companies / Contact roles

The list of roles for the company contacts.

Field	Description
ID	Globally unique ID.
Name	The name of a role. For example, admin or buyer.
Note	A note for the role.

Companies / Contacts

The list of contacts in 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.

Companies / Contacts / Customer

The customer associated to this contact.

Field	Description
Customer ID	Globally unique ID.

Companies / Default role

The role proposed by default for a contact at the company.

Field	Description
ID	Globally unique ID.
Name	The name of a role. For example, admin or buyer.
Note	A note for the role.

Companies / Draft orders

The list of draft orders for the company contact.

Field	Description
Draft order ID	Globally unique ID.

Companies / Events

The paginated list of events associated with the host subject.

Field	Description
App title	The name of the app that created the event.
Attribute to app	Whether the event was created by an app.
Attribute to user	Whether the event was caused by an admin user
Created at	The date and time when the event was created.
Critical alert	Whether the event is critical.
ID	Globally unique ID.
Message	Human readable text that describes the event.

Companies / 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.
Order count	The total number of orders placed for the location.
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.

Companies / 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.

Companies / Metafield definitions

List of metafield definitions.

Field	Description
Description	The description of the metafield definition.
ID	Globally unique ID.
Key	The unique identifier for the metafield definition within its namespace.
Metafields count	The count of the metafields that belong to the metafield definition.
Name	The human-readable name of the metafield definition.
Namespace	The container for a group of metafields that the metafield definition is associated with.
Pinned position	The position of the metafield definition in the pinned list.
Use as collection condition	Whether the metafield definition can be used as a collection condition.
Visible to storefront api	Whether each of the metafields that belong to the metafield definition are visible from the Storefront API.

Companies / 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.

Companies / Orders

The list of orders for the company contact.

Field	Description
Order ID	Globally unique ID.

Companies / Total spent

The total amount spent by this company, across all its locations.

Field	Description
Amount	Decimal money amount.
Currency code	Currency of the money.