Channels

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

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
`clover`	`pos`
`square`	`pos`
`stripe`	`pos`
`talech`	`pos`
`vend`	`pos`
`amazon`	`marketplace`
`belk`	`marketplace`
`catch`	`marketplace`
`ebay`	`marketplace`
`etsy`	`marketplace`
`facebook` (deprecated)	`marketplace`, `marketing`
`hudsons_bay`	`marketplace`
`google`	`marketplace`, `marketing`
`google_shopping` (deprecated)	`marketing`
`instagram` (deprecated)	`marketplace`, `marketing`
`macys`	`marketplace`
`meta`	`marketplace`, `marketing`
`microsoft`	`marketing`
`mirakl`	`marketplace`
`overstock`	`marketplace`
`pinterest`	`marketplace`
`target_plus`	`marketplace`
`tiktok`	`marketplace`
`wayfair`	`marketplace`
`wish`	`marketplace`
`walmart`	`marketplace`
`acquia`	`storefront`
`bigcommerce` (Stencil and Blueprint)	`storefront`
`bloomreach`	`storefront`
`catalyst` (BigCommerce Next.js)	`storefront`
`deity`	`storefront`
`drupal`	`storefront`
`gatsby`	`storefront`
`next` (Next.js Commerce and other Next.js)	`storefront`
`vue`	`storefront`
`wordpress`	`storefront`
`custom`	`storefront`, `pos`, `marketing`, `marketplace`

Status

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

Type	Writable Statuses
`storefront`	`prelaunch`, `active`, `inactive`, `archived`, `deleted`
`marketing`, `marketplace`, `pos`	`connected`, `disconnected`, `archived`, `deleted`

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.

For the “urls” object, we no longer modify the www prefix of the primary URL. The API returns URLs exactly as the customer enters them, similar to the “url” field.

If the customer saves a URL with www, the API returns it with www.
If the customer saves a URL without www, the API returns it without www.

Channels

Platform

Status

Channel listings

Channel site

Resources