Companies

List of companies in the shop. Represents information about companies which is also a customers of the shop.

Field	Description

Field	Description
Contacts count	The number of contacts that belong to the company.
Contacts count precision	Precision of contacts count, how exact is the value.
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 identifier.
Lifetime duration	The lifetime duration of the company, since it became a customer of the shop. Examples: 2 days, 3 months, 1 year.
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.
Total spent	The total amount spent by this company, across all its locations.
Updated at	The date and time (ISO 8601 format) at which the company was last modified.

The list of roles for the company contacts.

Field	Description

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

The list of contacts in the company.

Field	Description

Field	Description
Created at	The date and time (ISO 8601 format) at which the company contact was created at Shopify.
ID	Globally unique identifier.
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.

The customer associated to this contact.

Field	Description

Field	Description
Accepts marketing	Whether the customer has agreed to receive marketing materials.
Accepts marketing updated at	The date and time when the customer consented or objected to receiving marketing material by email.
Amount spent	The total amount that the customer has spent on orders in their lifetime.
Average order amount	The average amount that the customer spent per order.
Can delete	Whether the merchant can delete the customer from their store
Created at	The date and time when the customer was added to the store.
Display name	The full name of the customer, based on the values for first_name and last_name. If the first_name and last_name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number.
Email	The customer's email address.
First name	The customer's first name.
Has timeline comment	Whether the merchant has added timeline comments about the customer on the customer's page.
ID	Globally unique identifier.
Image alt text	A word or phrase to share the nature or contents of an image associated with the customer.
Last name	The customer's last name.
Lifetime duration	The amount of time since the customer was first added to the store.
Locale	The customer's locale.
Multipass identifier	A unique identifier for the customer that's used with Multipass login.
Note	A note about the customer.
Number of orders	The number of orders that the customer has made at the store in their lifetime.
Original image URL	The location of the original image associated with the customer as a URL.
Phone	The customer's phone number.
State	The state of the customer's account with the shop.
Tags	A comma separated list of tags that have been added to the customer.
Tax exempt	Whether the customer is exempt from being charged taxes on their orders.
Transformed image URL	The location of the transformed image associated with the customer as a URL.
Updated at	The date and time when the customer was last updated.
Valid email address	Whether the email address is formatted correctly. This does not guarantee that the email address actually exists.
Verified email	Whether the customer has verified their email address.

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

Field	Description

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