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. |
|
Contacts count |
The number of contacts that belong to the company. |
|
Contacts count precision |
Precision of contacts count, how exact is the value |
|
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. |
|
Locations count |
The number of locations that belong to the company. |
|
Locations count precision |
Precision of locations count, how exact is the value. |
|
Name |
The name of the company. |
|
Note |
A note about the company. |
|
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. |
|
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. |
|
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. |
Companies / Locations / Billing address
The address used as billing address for the location.
|
Field |
Description |
|---|---|
|
City |
The name of the city, district, village, or town. |
|
Company name |
The name of the company. |
|
Country |
The name of the country. |
|
Country code |
The two-letter code for the country of the address. |
|
Created at |
The date and time (ISO 8601 format) at which the company address was created. |
|
First line |
The first line of the address. Typically the street address or PO Box number. |
|
First name |
The first name of the recipient. |
|
Formatted address |
The formatted version of the address. |
|
Formatted area |
A comma-separated list of the values for city, province, and country. |
|
ID |
Globally unique ID. |
|
Last name |
The last name of the recipient. |
|
Phone |
A unique phone number for the customer. Formatted using E.164 standard. For example, +16135551111. |
|
Province |
The region of the address, such as the province, state, or district. |
|
Recipient |
The identity of the recipient e.g. 'Receiving Department'. |
|
Second line |
The second line of the address. Typically the number of the apartment, suite, or unit. |
|
Updated at |
The date and time (ISO 8601 format) at which the company address was last updated. |
|
Zip |
The zip or postal code of the address. |
|
Zone code |
The alphanumeric code for the region. For example, ON. |
Companies / 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. |
Companies / Locations / Role assignments
The list of roles assigned to the company location.
|
Field |
Description |
|---|---|
|
Created at |
The date and time (ISO 8601 format) when the assignment record was created. |
|
ID |
Globally unique ID. |
|
Updated at |
The date and time (ISO 8601 format) when the assignment record was last updated. |
Companies / Locations / Role assignments / Company contact
The company contact for whom this role is assigned.
|
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 / Locations / Role assignments / Company contact / Customer
The customer associated to this contact.
|
Field |
Description |
|---|---|
|
Customer ID |
Globally unique ID. |
Companies / Locations / Role assignments / Role
The role that's assigned to the company contact.
|
Field |
Description |
|---|---|
|
ID |
Globally unique ID. |
|
Name |
The name of a role. For example, admin or buyer. |
|
Note |
A note for the role. |
Companies / Locations / Shipping address
The address used as shipping address for the location.
|
Field |
Description |
|---|---|
|
City |
The name of the city, district, village, or town. |
|
Company name |
The name of the company. |
|
Country |
The name of the country. |
|
Country code |
The two-letter code for the country of the address. |
|
Created at |
The date and time (ISO 8601 format) at which the company address was created. |
|
First line |
The first line of the address. Typically the street address or PO Box number. |
|
First name |
The first name of the recipient. |
|
Formatted address |
The formatted version of the address. |
|
Formatted area |
A comma-separated list of the values for city, province, and country. |
|
ID |
Globally unique ID. |
|
Last name |
The last name of the recipient. |
|
Phone |
A unique phone number for the customer. Formatted using E.164 standard. For example, +16135551111. |
|
Province |
The region of the address, such as the province, state, or district. |
|
Recipient |
The identity of the recipient e.g. 'Receiving Department'. |
|
Second line |
The second line of the address. Typically the number of the apartment, suite, or unit. |
|
Updated at |
The date and time (ISO 8601 format) at which the company address was last updated. |
|
Zip |
The zip or postal code of the address. |
|
Zone code |
The alphanumeric code for the region. For example, ON. |
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. |
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. |