Channels

  • Servers:
    • https://api.bigcommerce.com/stores/store_hash/v3

Create and manage sales channels, their sites, and their product listings.

Authentication

Authenticate requests by including an OAuth access_token in the request header.

GET https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/channels
Content-Type: application/json
X-Auth-Token: {{ACCESS_TOKEN}}

OAuth Scopes

UI Name Permission Parameter
Channel Listings modify store_channel_listings
Channel Listings read-only store_channel_listings_read_only
Channel Settings modify store_channel_settings
Channel Settings read-only store_channel_settings_read_only

Channels

A channel is anywhere a merchant sells their products. This encompasses headless storefronts, marketplaces, POS systems, and marketing platforms.

Platform

A channel’s type and platform combination must be a valid pair as indicated in the table below.

Platform Accepted Type
square pos
stripe pos
vend pos
clover pos
talech pos
facebook marketplace,marketing
instagram marketplace,marketing
amazon marketplace
ebay marketplace
pinterest marketplace
wayfair marketplace
overstock marketplace
etsy marketplace
wish marketplace
walmart marketplace
gatsby storefront
wordpress storefront
drupal storefront
acquia storefront
bloomreach storefront
deity storefront
next storefront
vue storefront
google_shopping marketing
custom storefront, pos, marketing, marketplace

Status

Allowed values for a channel’s status vary by channel type and platform.

Type Platform Allowed Statuses
storefront bigcommerce prelaunch, active, inactive, archived, deleted
storefront Is not bigcommerce active, inactive, disconnected, archived, deleted
marketing, marketplace, pos N/A connected, disconnected, archived, deleted

Note

  • A Channel with deleted status can be restored within 90 days after deleting by contacting BigCommerce support team. Once the 90 days grace period is over, the Channel status will become terminated.
  • The terminated status is read-only. terminated channels cannot be restored.
  • As of April 2020, status should be used in place of is_enabledis_enabled is deprecated.

Channel listings

Channel listings allow you to manage catalog differences among different storefronts or marketplaces.

Channel site

A Channel site refers to the domain associated with a channel.

Resources