Companies
Lists business-to-business (B2B) companies configured in the shop.
Table-Specific Information
Select
The connector uses the Shopify API to process WHERE clause conditions built with the following columns and operators. The connector processes other filters client-side within the connector.
- 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.
For example, the following queries are processed server-side:
SELECT * FROM Companies WHERE Id = 'Val1'
SELECT * FROM Companies WHERE ExternalId = 'Val1'
SELECT * FROM Companies WHERE Name = 'Val1'
SELECT * FROM Companies WHERE CustomerSince = '2023-01-01 11:10:00'
SELECT * FROM Companies WHERE CreatedAt = '2023-01-01 11:10:00'
SELECT * FROM Companies WHERE UpdatedAt = '2023-01-01 11:10:00'
Insert
The following columns can be used to create a new record:
ExternalId, Name, Note, CustomerSince
Update
The following columns can be updated:
ExternalId, Name, Note, MainContactId
Delete
You can delete entries by specifying the following column:
Id
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The globally unique identifier of the company. | |
| ExternalId | String | False |
An externally supplied identifier used to uniquely reference the company outside of Shopify. | |
| Name | String | False |
The name of the company. | |
| Note | String | False |
A merchant-facing note about the company. | |
| ContactsCount | Int | True |
The number of contacts associated with the company. | |
| ContactsCountPrecision | String | True |
The level of precision applied to the contact count value. | |
| CustomerSince | Datetime | True |
The date and time when the company became a customer. | |
| DefaultCursor | String | True |
A default cursor used to retrieve the next company record in ascending ID order. | |
| LifetimeDuration | String | True |
The duration of time since the company became a customer, expressed as a readable interval such as '2 days', '3 months', or '1 year'. | |
| LocationsCount | Int | True |
The number of locations linked to the company. | |
| LocationsCountPrecision | String | True |
The level of precision applied to the location count value. | |
| OrdersCount | Int | True |
The total number of orders placed by the company across all of its locations. | |
| OrdersCountPrecision | String | True |
The level of precision applied to the order count value. | |
| HasTimelineComment | Bool | True |
Indicates whether a timeline comment has been added to the company record by the merchant. | |
| CreatedAt | Datetime | True |
The date and time when the company was created in Shopify. | |
| UpdatedAt | Datetime | True |
The date and time when the company record was last updated. | |
| DefaultRoleId | String | True |
The globally unique identifier of the company's default role. | |
| DefaultRoleName | String | True |
The name of the company's default role, such as 'admin' or 'buyer'. | |
| DefaultRoleNote | String | True |
A note associated with the company's default role. | |
| MainContactId | String | True |
The globally unique identifier of the company's main contact. | |
| TotalSpentAmount | Decimal | True |
The total amount spent by the company, expressed as a decimal money value. | |
| TotalSpentCurrencyCode | String | True |
The currency code for the company's total spent amount. |