Cmdlets for BigCommerce

Build 24.0.9060

ChannelListings

Returns a list of all Channel Listings for a specific channel

Table Specific Information

Select

The cmdlet uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:

  • Listingid supports the '='.
  • ChannelId supports the '='.
  • Datecreated supports the '='.
  • Datemodified supports the '='.

ChannelId or (ChannelId and ListingId) are required for SELECT.

The rest of the filter is executed client-side within the cmdlet.

For example, the following queries are processed server-side:

SELECT * FROM ChannelListings WHERE ChannelId = 667159 AND ListingId = 882998595

Insert

To insert a new ChannelListings, you need to specify at least the following columns: Productid, State, Variants, ChannelId and Name.

INSERT INTO ChannelListings (Productid, State, Variants, ChannelId) VALUES (12345, 'active', 'test', 667159)

Update


UPDATE ChannelListings SET name = 'Test' WHERE ChannelId = 667159

Columns

Name Type ReadOnly References Description
Listingid [KEY] Long True

The ID of the channel listing that has been created, returned, or updated

ChannelId [KEY] Integer True

Channels.Id

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

Variants String False

Product variant associated with the channel listing.

Pseudo-Columns

Pseudo column fields are used to enable the user to INSERT Fields that are non-readable but required during creation of new records.

Name Type Description
ExternalId Integer

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060