Channels Toolkit Reference

The Channel Toolkit is a set of APIs, UI components, patterns, and app frameworks that provide partners and 3rd party developers with the ability to build integrations between BigCommerce and external sales channels. This article serves as a comprehensive list of all the tools in the toolkit for quick reference. For a general overview of channels and developing channel apps on BigCommerce, see Channels Overview.

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
Channels Toolkit Reference Channels toolkit quick reference

Endpoints

Required for Channel Apps:

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 for Channel Apps:

Endpoint Description
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

Extended Functionality:

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

Link
BigDesign Developer Playground
CodeSandbox Example
GitHub Repo
Figma UI Kit
Example App

For a complete reference of all BigCommerce API endpoints, see: API Reference.

User Flows

  • Onboarding - user flows that enable a merchant to connect their BC store to an external channel, inclusive of creating an account on the external channel if needed.
    • Channel configuration
    • Settings
  • Catalog Management - user flows that enable a merchant to manage their product catalog data between their BC store and external channels, inclusive of product, inventory, and pricing information.
    • Import
    • Export
    • Per product listing
    • Inventory
  • Order Management - user flows that enable a merchant to manage orders between their BC store and external channels.
    • Orders
    • Shipping
  • Notifications - user flows that enable a merchant to easily find and manage important notifications related to their channel, inclusive of errors, warnings, and general helpful notifications, such as pending channel updates or changes.