Thanks for being patient while we implement your feedback to improve the developer experience.
API Docs
Building Channels
Quick Start

Building Channels Quick Start

This advanced, quick-start tutorial is for BigCommerce partners (opens in a new tab) wishing to market their solution within Channel Manager's Create Channel flow. For an introduction to channels on BigCommerce, see Channels Overview.

Prerequisites

Create a channel

Apps curated as solutions within the Create Channel flow must create a basic channel with a reference to their BigCommerce App ID. This enables them to be shown in the Channel Manager as managing a specific channel; it also improves the native look and feel for the merchant using the app.

Channel Manager
Channel Manager

To create a channel, send a POST request to /v3/channels.

Example request: Create a channel
POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/channels
X-Auth-Token: {{ACCESS_TOKEN}}
Content-Type: application/json
Accept: application/json
 
{
  "name": "Solution Name",
  "type": "storefront",
  "platform": "drupal",
  "external_id": "",
  "is_enabled": true,
  "status": "connected",
  "is_listable_from_ui": true,
  "is_visible": true,
  "config_meta": {
    "app": {
      "id": 24483
    }
  }
}

Create a channel with navigation

We recommend that apps also create navigation sections to better integrate the app's interface within the BigCommerce control panel.

Channel Settings Overview Tab
Channel Settings Overview Tab

To create a channel with navigation, use the Channel Menus API after creating a channel record.

Example request: Create channel menus
POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/channels/{{CHANNEL_ID}}/channel-menus
X-Auth-Token: {{ACCESS_TOKEN}}
Content-Type: application/json
Accept: application/json
 
{
    "bigcommerce_protected_app_sections": [
      "domains",
      "currencies",
      "storefront_settings"
    ],
    "custom_app_sections": [
      {
        "title": "Overview",
        "query_path": "overview"
      }
    ]  
}

Related resources

Articles

Endpoints