ChannelListings
Returns a list of all Channel Listings for a specific channel.
Table Specific Information
Select
The component uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:
- Listingid supports the = comparison.
- ChannelId supports the = comparison.
- Datecreated supports the =, >, <, >=, and <= comparisons.
- Datemodified supports the =, >, <, >=, and <= comparisons.
The rest of the filter is executed client-side within the component. For example, the following queries are processed server-side:
SELECT * FROM ChannelListings WHERE ChannelId = 667159 AND ListingId = 882998595
Insert
To insert a channel listing, specify the following columns: ProductId, State, Variants, ChannelId, and Name.
INSERT INTO ChannelListings (Productid, State, Variants, ChannelId) VALUES (12345, 'active', 'test', 667159)
Update
The following example illustrates how to update ChannelListings:
UPDATE ChannelListings SET name = 'Test' WHERE ChannelId = 667159
Columns
| Name | Type | ReadOnly | Description |
| ListingId [KEY] | Integer | True |
The Id of the channel listing that has been created, returned, or updated. |
| ChannelId [KEY] | Integer | False |
The Id of the channel associated with this channel listing. |
| Datecreated | Datetime | True |
Date on which the channel listing was first created. |
| Datemodified | Datetime | True |
Date on which the channel listing was most recently changed. |
| Name | String | False |
Name of the product for this channel listing specifically. This is an optional field that can be used to override the product name in the catalog. |
| Description | String | True |
Description of the product for this channel listing specifically. This is an optional field that can be used to override the product description in the catalog. |
| Productid | Integer | False |
The Id of the product associated with this channel listing. |
| State | String | False |
The state of the product assignment or channel listing. Possible values are: active, disabled, error, pending, pending_disable, pending_delete, partially_rejected, queued, rejected, submitted, or deleted. |
| Variants | String | False |
Product variant associated with the channel listing. |
| ExternalId | String | False |
Associated Id within a system or platform outside of BigCommerce. |