> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.bigcommerce.com/_mcp/server. # Channels Create and manage sales [channels](/developer/docs/integrations/channels), their [sites](/developer/api-reference/rest/admin/management/channels/site), and their [product listings](/developer/api-reference/rest/admin/management/channels/listings). ## Channels A [channel](/developer/api-reference/rest/admin/management/channels) 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`, `marketing` | | `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` | | `openai` | `marketplace`, `marketing` | | `overstock` | `marketplace` | | `paypal` | `marketplace`, `marketing` | | `perplexity` | `marketplace`, `marketing` | | `pinterest` | `marketplace`, `marketing` | | `reddit` | `marketing` | | `snapchat` | `marketing` | | `target_plus` | `marketplace` | | `tiktok` | `marketplace`, `marketing` | | `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` | > **Note** > > * 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](/developer/api-reference/rest/admin/management/channels/listings) allow you to manage catalog differences among different storefronts or marketplaces. ## Channel site A [Channel site](/developer/api-reference/rest/admin/management/channels/site) refers to the domain associated with a channel. > **Note** > > 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](/developer/api-reference/rest/admin/management/sites) * [Building Channels Overview](/developer/docs/integrations/channels) * [Building Channel Apps](/developer/docs/integrations/channels/guide) * [Channels Toolkit Reference](/developer/docs/integrations/channels/channels-toolkit-reference) > Build amazing commerce solutions powered by the BigCommerce platform ## API Docs - Admin Management: Channels [List Channels](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/get-channels.md) - Admin Management: Channels [Create Channel](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/create-channel.md) - Admin Management: Channels [Get Channel](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/get-channel.md) - Admin Management: Channels [Update Channel](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/update-channel.md) - Admin Management: Channels > Active Theme [Get Channel Active Theme](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/active-theme/get-channel-active-theme.md) - Admin Management: Channels > Batch Metafields [List Channel Metafields](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/batch-metafields/get-channels-metafields.md) - Admin Management: Channels > Batch Metafields [Create Multiple Metafields](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/batch-metafields/create-channels-metafields.md) - Admin Management: Channels > Batch Metafields [Update Multiple Metafields](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/batch-metafields/update-channels-metafields.md) - Admin Management: Channels > Batch Metafields [Delete Multiple Metafields](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/batch-metafields/delete-channels-metafields.md) - Admin Management: Channels > Currency Assignments [List Channels Currency Assignments](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/currency-assignments/get-all-currency-assignments.md) - Admin Management: Channels > Currency Assignments [Create Multiple Channels Currency Assignments](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/currency-assignments/create-multiple-channels-currency-assignments.md) - Admin Management: Channels > Currency Assignments [Update Multiple Channels Currency Assignments](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/currency-assignments/update-multiple-channels-currency-assignments.md) - Admin Management: Channels > Currency Assignments [List Channel Currency Assignments](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/currency-assignments/get-single-channel-currency-assignments.md) - Admin Management: Channels > Currency Assignments [Create Channel Currency Assignments](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/currency-assignments/create-single-channel-currency-assignments.md) - Admin Management: Channels > Currency Assignments [Update Channel Currency Assignments](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/currency-assignments/update-single-channel-currency-assignments.md) - Admin Management: Channels > Currency Assignments [Delete Channel Currency Assignments](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/currency-assignments/delete-single-channel-currency-assignments.md) - Admin Management: Channels > Listings [List Channel Listings](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/listings/get-channel-listings.md) - Admin Management: Channels > Listings [Create Channel Listings](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/listings/create-channel-listings.md) - Admin Management: Channels > Listings [Update Channel Listings](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/listings/update-channel-listings.md) - Admin Management: Channels > Listings [Get Channel Listing](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/listings/get-channel-listing.md) - Admin Management: Channels > Menus [List Channel Menus](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/menus/get-channel-menus.md) - Admin Management: Channels > Menus [Create Channel Menus](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/menus/create-channel-menus.md) - Admin Management: Channels > Menus [Delete Channel Menus](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/menus/delete-channel-menus.md) - Admin Management: Channels > Metafields [List Channel Metafields](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/metafields/get-channel-metafields.md) - Admin Management: Channels > Metafields [Create Channel Metafield](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/metafields/create-channel-metafield.md) - Admin Management: Channels > Metafields [Get Channel Metafield](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/metafields/get-channel-metafield.md) - Admin Management: Channels > Metafields [Update Channel Metafield](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/metafields/update-channel-metafield.md) - Admin Management: Channels > Metafields [Delete Channel Metafield](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/metafields/delete-channel-metafield.md) - Admin Management: Channels > Site [Get Channel Site](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/site/get-channel-site.md) - Admin Management: Channels > Site [Create Channel Site](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/site/create-channel-site.md) - Admin Management: Channels > Site [Update Channel Site](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/site/update-channel-site.md) - Admin Management: Channels > Site [Delete Channel Site](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/site/delete-channel-site.md) - Admin Management: Channels > Site Checkout URL [Upsert Siteʼs Checkout URL](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/site-checkout-url/update-checkout-url.md) - Admin Management: Channels > Site Checkout URL [Delete Siteʼs Checkout URL](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/site-checkout-url/delete-checkout-url.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/openapi.json) - [OpenAPI YAML](https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/channels/openapi.yaml)