Management APIs
Building Apps
Quick Start
Guide
Tutorials
Building Storefronts
Overview
Embedded Checkout
Next.js Commerce
Managing Currencies
Guide
Partner Information
Becoming A Partner
Getting Started
POS Solutions
ERP Solutions
PIM Solutions
OMS Solutions
Marketing Solutions
Shipping Solutions
Payment Solutions

Channels Toolkit Reference

This article serves as a comprehensive list of all the tools in Channels Toolkit for quick reference. For a general overview of channels and developing channel apps on BigCommerce, see Channels Introduction.

Required endpoints

All channels must integrate the following endpoints.

Endpoint Description
Channels Create and manage product listings for multiple storefronts and sales channels
Listings Create and manage product listings for multiple storefronts and sales channels
Orders Get and manage order data
Products Manage products, options, variants, and modifiers

Recommended endpoints

The following endpoints are recommended for most channels.

Endpoint Description
Channel Currency Assignments Manage channel specific currency settings
Price Lists Control variant-level pricing by channel, customer group, etc
Store Information Get store metadata
Shipping Manage how products are shipped
Webhooks Get notified when specific events occur in a BigCommerce store
Routes Create and manage page routes for headless storefronts
Sites Create and manage sites associated with a channel
Settings Read global and channel specific settings

Extended functionality endpoints

The following endpoints provide extended functionality to channels.

Endpoint Description
Carts Create and manage carts
Checkouts Create and manage checkouts
Customers Create and Manage Customers, Customer Addresses, and Customer Attributes.
Currencies Manage accepted currencies and their display
Coupons Manage coupons
Gift Certificates Manage gift certificates
Customer Login Use SSO to login customers
Current Customer Securely identify current customer
Order Payment Actions Authorize, capture, and void order payments
Order Transactions Get order payment transaction data

UI components

To assist in the rapid development of apps that match the native UI and UX of the control panel, BigCommerce provides UI components and design guidelines to developers via BigDesign – BigCommerce’s library of React components.

Link Description
BigDesign Developer Playground BigDesign react component documentation and playground
CodeSandbox Example CodeSandbox app show-casing BigDesign components
Big Design Repo GitHub repository for BigDesign components
Figma UI Kit Figma UI kit for BigDesign components

Required UI components

The following UI components are required for channels.

Recommended UI components

The following UI components are highly recommended for channels.

Documentation

Link Description
Channels Overview High-level overview of channels and developing channels apps on BigCommerce
Building Channel Apps In-depth technical guide to building a channel app
Extending Sales Channel Apps with Channels Toolkit Tutorial on intregrating Channels Toolkit into existing apps
Channel App Best Practices List of best practices for channel apps
Building a Storefront Channel Tutorial on creating a channel app for a headless storefront