Companies
Returns the list of companies in the shop.
Table-Specific Information
Select
The component uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- ExternalId supports the '=,!=' comparison operators.
- Name supports the '=,!=' comparison operators.
- CustomerSince supports the '=,!=' comparison operators.
- CreatedAt supports the '=,<,>,>=,<=' comparison operators.
- UpdatedAt supports the '=,<,>,>=,<=' comparison operators.
The component processes other filters client-side within the component.
For example, the following queries are processed server-side:
SELECT * FROM Companies WHERE Id='VALUE'
SELECT * FROM Companies WHERE ExternalId='VALUE'
SELECT * FROM Companies WHERE Name='VALUE'
SELECT * FROM Companies WHERE CustomerSince='2000-01-01 01:00:00.0'
SELECT * FROM Companies WHERE CreatedAt<'2000-01-01 01:00:00.0'
SELECT * FROM Companies WHERE UpdatedAt<'2000-01-01 01:00:00.0'
Insert
INSERT statements are mapped to the 'companyCreate' GraphQL mutation.
The following columns can be used to create a new record:
ExternalId, Name, Note, CustomerSince
UPDATE
UPDATE statements are mapped to the 'companyUpdate' GraphQL mutation.
The following columns can be updated:
ExternalId, Name, Note
DELETE
DELETE statements are mapped to the 'companyDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | True |
A globally-unique ID. | |
ExternalId | String | False |
A unique externally-supplied ID for the company. | |
Name | String | False |
The name of the company. | |
Note | String | False |
A note about the company. | |
ContactCount | Int | True |
The number of contacts that belong to the company. | |
CustomerSince | Datetime | True |
The date and time at which the company became the customer. | |
DefaultCursor | String | True |
A default cursor that returns the single next record, sorted ascending by ID. | |
LifetimeDuration | String | True |
The lifetime duration of the company, since it became a customer of the shop. Examples: '2 days', '3 months', '1 year'. | |
LocationCount | Int | True |
The number of locations that belong to the company. | |
OrderCount | Int | True |
The total number of orders placed for this company, across all its locations. | |
HasTimelineComment | Bool | True |
Whether the merchant added a timeline comment to the company. | |
CreatedAt | Datetime | True |
The date and time at which the company was created in Shopify. | |
UpdatedAt | Datetime | True |
The date and time at which the company was last modified. | |
DefaultRoleId | String | True |
A globally-unique ID. | |
DefaultRoleName | String | True |
The name of a role. For example, 'admin' or 'buyer'. | |
DefaultRoleNote | String | True |
A note for the role. | |
MainContactId | String | True |
A globally-unique ID. | |
TotalSpentAmount | Decimal | True |
Decimal money amount. | |
TotalSpentCurrencyCode | String | True |
Currency of the money. |