Channels
Manages and lists BigCommerce sales channels, supporting SELECT, INSERT, and UPDATE channel records.
Table Specific Information
Select
The add-in uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:
- Id supports the = comparison.
- Datecreated supports the =, >, <, >=, and <= comparisons.
- Datemodified supports the =, >, <, >=, and <= comparisons.
The rest of the filter is executed client-side within the add-in. For example, the following queries are processed server-side:
SELECT * FROM Channels
Insert
To insert a channel, specify the following columns: Name, Type, Platform, and Status.
INSERT INTO Channels (Type, Platform, Status, Name) VALUES ('pos', 'square', 'active', 'tests');
Update
The following example illustrates how to update Channels:
UPDATE Channels SET Name = 'tests' WHERE ID = 123
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | True |
The Id of the channel. |
| ConfigMetaAppId | Integer | False |
The unique Id given to an app registered in DevTools. |
| sections | String | False |
If set, when the app is loaded within the control panel, the navigation sections are directly embedded in the control panel navigation. |
| Datecreated | Datetime | True |
Date on which the channel was first created. |
| Datemodified | Datetime | True |
Date on which the channel was most recently changed. |
| Externalid | String | False |
Associated Id within a system or platform outside of BigCommerce. |
| Iconurl | String | False |
Link to the platform icon. |
| Isenabled | Boolean | False |
A channel with a status of prelaunch, active, or connected has 'is_enabled' set to true. A channel with a status of inactive, disconnected, archived, deleted, or terminated has 'is_enabled' set to false. |
| IslistableFromUi | Boolean | False |
Indicates whether a channel can create listings from the BigCommerce UI. The default value for this field is based on the channel type and platform combination if not specified on create. |
| Isvisible | Boolean | False |
Indicates whether a channel is visible within the BigCommerce merchant admin UI (control panel). If false, the channel does not show in Channel Manager nor in any channels dropdown throughout the UI. The default value for this field is true if not specified on create. |
| Name | String | False |
Name of the channel as it appears to merchants in the control panel. |
| Platform | String | False |
The name of the platform for the channel platform and type must be a valid combination. |
| Status | String | False |
The status of the channel type, platform, and status must be a valid combination. Possible values are: active, prelaunch, inactive, connected, disconnected, archived, deleted, or terminated. Terminated is not valid for update or insert requests. |
| Type | String | False |
The type of channel platform and type must be a valid combination. Possible values are: pos, marketplace, storefront, or marketing. |