Partner Information
Becoming A Partner
Getting Started
POS Solutions
ERP Solutions
PIM Solutions
OMS Solutions
Marketing Solutions
Shipping Solutions
Payment Solutions
Provider APIs
Building Apps
Quick Start
Guide
Tutorials
Building Channels
Quick Start
Guide
Tutorials
new
Building Storefronts
Overview
Embedded Checkout
Managing Currencies
Guide

Building Channels Quick Start

This article is an advanced quick start tutorial for BigCommerce partners 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.

channels-quick-start-01

And, it also enables an improved native look and feel for the merchant using the app.

channels-quick-start-02

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

POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/channels
X-Auth-Token: {{ACCESS_TOKEN}}
X-Auth-Client: {{CLIENT_ID}}
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
    }
  }
}

Open in Request Runner

Note

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.

channels-quick-start-03

To create a channel with navigation, include a config_meta object in the create a channel request.

POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/channels
X-Auth-Token: {{ACCESS_TOKEN}}
X-Auth-Client: {{CLIENT_ID}}
Content-Type: application/json
Accept: application/json

{
  "name": "Solution Name",
  "type": "storefront",
  "platform": "drupal",
  "external_id": "",
  "status": "connected",
  "is_listable_from_ui": true,
  "is_visible": true,
  "config_meta": {
    "app": {
      "id": 24483,
      "sections": [
        {
          "title": "Overview",
          "query_path": "overview"
        },
        {
          "title": "Import",
          "query_path": "import"
        },
        {
          "title": "Settings",
          "query_path": "settings"
        }
      ]
    }
  }
}

Open in Request Runner

Note

Resources