For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
      • Overview
        • Abandoned Carts
        • Carts
        • Channels
            • GETList Channels
            • POSTCreate Channel
            • GETGet Channel
            • PUTUpdate Channel
        • Checkouts
        • Currencies
        • Customer Segmentation
        • Geography
        • Infrastructure Hosting
        • Inventory
        • Orders
        • Order Operations
        • Pickup
        • Pickup Methods
        • Pickup Options
        • Pricing
        • Price Lists
        • Promotions
        • Promotion Settings
        • Redirects
        • Scripts
        • Settings
        • Shipping
        • Sites
        • Subscribers
        • System Logs
        • Tax
        • Wishlists
      • Payments
  • GraphQL
    • Overview
  • MCP
    • Overview
Dev Portal
LogoLogo
On this page
  • Channels
  • Platform
  • Status
  • Channel listings
  • Channel site
  • Resources
RESTAdminManagement

Channels

Was this page helpful?
Previous

Update Channel Cart Settings

Next

List Channels

Built with

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
facebook (deprecated)marketplace, marketing
hudsons_baymarketplace
googlemarketplace, marketing
google_shopping (deprecated)marketing
instagram (deprecated)marketplace, marketing
macysmarketplace
metamarketplace, marketing
microsoftmarketing
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
  • 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.

Resources

  • Sites and Routes API Reference
  • Building Channels Overview
  • Building Channel Apps
  • Channels Toolkit Reference