read_customers
access scope or read_companies
access scope. Also: The API client must be installed on a Shopify Plus store.
Represents information about a company which is also a customer of the shop.
Fields and connections
The list of roles for the company contacts.
The list of contacts in the company.
The number of contacts that belong to the company.
The date and time (ISO 8601 format) at which the company was created in Shopify.
The date and time (ISO 8601 format) at which the company became the customer.
A default cursor that returns the single next record, sorted ascending by ID.
The role proposed by default for a contact at the company.
The list of the company's draft orders.
The paginated list of events associated with the host subject.
A unique externally-supplied ID for the company.
Whether the merchant added a timeline comment to the company.
A globally-unique ID.
The lifetime duration of the company, since it became a customer of the shop. Examples:
2 days
,3 months
,1 year
.The list of locations in the company.
The number of locations that belong to the company.
The main contact for the company.
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.A list of custom fields that a merchant associates with a Shopify resource.
The name of the company.
A note about the company.
The list of the company's orders.
The total number of orders placed for this company, across all its locations.
The total amount spent by this company, across all its locations.
The date and time (ISO 8601 format) at which the company was last modified.
Returns a
Company
object by ID.Returns the list of companies in the shop.
Mutations
Assigns the main contact for the company.
Creates a company.
Revokes the main contact from the company.
Updates a company.