Docs
Management API
Channels

Channels

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

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.

PlatformAccepted Type
cloverpos
squarepos
stripepos
talechpos
vendpos
amazonmarketplace
belkmarketplace
catchmarketplace
ebaymarketplace
etsymarketplace
facebookmarketplace, marketing
hudsons_baymarketplace
googlemarketplace, marketing
google_shopping (deprecated)marketing
instagrammarketplace, marketing
macysmarketplace
miraklmarketplace
overstockmarketplace
pinterestmarketplace
target_plusmarketplace
tiktokmarketplace
wayfairmarketplace
wishmarketplace
walmartmarketplace
acquiastorefront
bigcommerce (Stencil and Blueprint)storefront
bloomreachstorefront
catalyst (BigCommerce Next.js)storefront
deitystorefront
drupalstorefront
gatsbystorefront
next (Next.js Commerce and other Next.js)storefront
vuestorefront
wordpressstorefront
customstorefront, pos, marketing, marketplace

Status

Allowed values for a channelʼs status vary by channel type.

TypeWritable Statuses
storefrontprelaunch, active, inactive, archived, deleted
marketing, marketplace, posconnected, disconnected, archived, deleted

Warning

  • You can restore a Channel with deleted status within 90 days after deletion by contacting the BigCommerce support team. After the 90-days grace period is over, the Channel status will become terminated.
  • The terminated status is read-only. Channels with a status of terminated cannot be restored.

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

Get All Channels

GET /channels

Request

Returns a list of Channels.

Will always return the default BigCommerce storefront with an ID of 1. This storefront is created by default when you provision a BigCommerce store.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • include in query - string

    Channels subresources that can be included in the response.

    Allowed: currencies

  • available in query - boolean

    Filter items based on whether the channel is currently available for integration. Setting this query parameter to true will return channels with the status of prelaunch, active , inactive, and connected. Setting this query parameter to false will return channels with the status of disconnected, archived, deleted, and terminated.

  • status:in in query - array

    Filter items by a comma-separated list of statuses.

    Type: array[string]

    Allowed: prelaunch | active | inactive | connected | disconnected | archived | deleted | terminated

  • type:in in query - array

    Filter items by a comma-separated list of types.

    Type: array[string]

    Allowed: marketplace | marketing | pos | storefront

  • platform:in in query - array

    Filter items by a comma-separated list of platforms. For a list of supported platforms, see Platform.

    Type: array[string]
    Example: ["facebook by meta,amazon"]

  • date_created in query - string

    Filter items by date_created. For example, date_created=2019-09-04T00:00:00, date_created=2019-09-04, or date_created=1567573200

  • date_created:min in query - string

    Filter items by minimum date_created. For example, date_created:min=2019-09-04T00:00:00, date_created:min=2019-09-04, or date_created:min=1567573200

  • date_created:max in query - string

    Filter items by maximum date_created. For example, date_created:max=2019-09-04T00:00:00, date_created:max=2019-09-04, or date_created:max=1567573200

  • date_modified in query - string

    Filter items by date_modified. For example, date_modified=2019-09-04T00:00:00, date_modified=2019-09-04, or date_modified=1567573200

  • date_modified:min in query - string

    Filter items by minimum date_modified. For example, date_modified:min=2019-09-04T00:00:00, date_modified:min=2019-09-04, or date_modified:min=1567573200

  • date_modified:max in query - string

    Filter items by maximum date_modified. For example, date_modified:max=2019-09-04T00:00:00, date_modified:max=2019-09-04, or date_modified:max=1567573200

  • limit in query - integer

    Controls the number of items per page for paginated responses.

  • page in query - integer

    Specifies the page number for a paginated response.

example

Response

Body

object | application/json
  • data
    array[object]
    required

  • meta
    object
    required

    Data about the response, including pagination.

response

Create a Channel

POST /channels

Request

Creates a Channel.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string
    required

    The MIME type of the request body.

Body

object | application/json
  • config_meta
    object

    Optional channel configuration object.

  • external_id
    string

    Associated ID within a system / platform outside of BC.

  • is_listable_from_ui
    boolean

    Indicates if a channel can create listings from the BigCommerce UI. Default value for this field is based on the channel type and platform combination if not specified on create.

  • is_visible
    boolean

    Indicates if a channel is visible within the BigCommerce merchant admin UI (control panel). If false, the channel will not show in Channel Manager nor in any channels dropdown throughout the UI. Default value for this field is true if not specified on create.

  • status
    string

    The status of the channel; channel type, platform, and status must be a valid combination. terminated is not valid for PUT or POST requests. deleted is not valid for POST requests.

    Allowed: active | prelaunch | inactive | connected | disconnected | archived | deleted | terminated

  • name
    string
    required

    Name of the channel as it will appear in the store control panel. The only characters it can include are Latin alphabet letters, Arabic numerals, dashes, and underscores.

  • type
    string
    required

    The type of channel; channel platform and type must be a valid combination.

    Allowed: pos | marketplace | storefront | marketing

  • platform
    string
    required

    The name of the platform for the channel; channel platform and type must be a valid combination.

Create eBay Channel

Response

Body

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

response

Get a Channel

GET /channels/{channel_id}

Request

Returns a Channel. Channel ID 1 returns the default BigCommerce storefront.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • include in query - string

    Channels subresources that can be included in the response.

    Allowed: currencies

example

Response

Body

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

response

Update a Channel

PUT /channels/{channel_id}

Request

Updates a Channel.

Updatable Fields

The following fields can be updated.

  • name
  • external_id
  • status
  • is_listable_from_ui
  • is_visible
  • config_meta

Note

  • Partial updates are supported. In most cases, if a field that cannot be updated is passed in, the API will not respond with an error. It returns a 200 response with the object, in which you will see the field(s) were not updated.
  • platform and type cannot be updated after a channel is created.
  • A channel with status deleted or terminated cannot be updated.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string
    required

    The MIME type of the request body.

Body

object | application/json
  • config_meta
    object

    Optional channel configuration object.

  • external_id
    string

    Associated ID within a system / platform outside of BC.

  • is_listable_from_ui
    boolean

    Indicates if a channel can create listings from the BigCommerce UI. Default value for this field is based on the channel type and platform combination if not specified on create.

  • is_visible
    boolean

    Indicates if a channel is visible within the BigCommerce merchant admin UI (control panel). If false, the channel will not show in Channel Manager nor in any channels dropdown throughout the UI. Default value for this field is true if not specified on create.

  • name
    string

    Name of the channel as it will appear in the store control panel. The only characters it can include are Latin alphabet letters, Arabic numerals, dashes, and underscores.

  • status
    string

    The status of the channel; channel type, platform, and status must be a valid combination. terminated is not valid for PUT or POST requests. deleted is not valid for POST requests.

    Allowed: active | prelaunch | inactive | connected | disconnected | archived | deleted | terminated

Update a Facebook by Meta Channel

Response

Body

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

response

Did you find what you were looking for?