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 (opens in a new tab) -- BigCommerce’s library of React components.
| Link | Description |
|---|---|
| BigDesign Developer Playground (opens in a new tab) | BigDesign react component documentation and playground |
| CodeSandbox app (opens in a new tab) | CodeSandbox app showcasing BigDesign components |
| BigDesign Repo (opens in a new tab) | GitHub repository for BigDesign components |
| Figma UI Kit (opens in a new tab) | Figma UI kit for BigDesign components |
Required UI components
The following UI components are required for channels.
- Typography (opens in a new tab)
- Tabs (opens in a new tab)
- Panel (opens in a new tab)
- Link (opens in a new tab)
- Icons (opens in a new tab)
- Button (opens in a new tab)
- Progress Circle (opens in a new tab)
- Badge (opens in a new tab)
- Dropdown (opens in a new tab)
- Table (opens in a new tab)
- Box (opens in a new tab)
Recommended UI components
The following UI components are highly recommended for channels.
- Alerts (opens in a new tab)
- Form (opens in a new tab)
- Input (opens in a new tab)
- Tooltip (opens in a new tab)
Documentation
| Link | Description |
|---|---|
| Channels overview | High-level overview of channels and developing channels apps on BigCommerce |
| Channels guide | In-depth technical guide to building a channel app |
| Extending existing apps with the channels toolkit | Guide to integrating the channels toolkit into existing apps |
| Channel app best practices | List of best practices for channel apps |
| Building storefront channels | Guide to creating a channel app for a headless storefront |