How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
BigCommerce

BigCommerce Channels API

The Channels API from BigCommerce — 2 operation(s) for channels.

Documentation Provider Profile APIs.io OpenAPI GitHub

BigCommerce Channels API is one of 161 APIs that BigCommerce publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Channels. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 4 operations across 2 paths, and defines 24 schemas. It is described by OpenAPI 3.0.0, at version 3.0.0.

Requests are made against a single base URL, https://api.bigcommerce.com/stores/{store_hash}/v3.

4 operations 2 paths 24 schemas 2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.0.0
Base URL
https://api.example.com
Authentication
API Key
Contact
BigCommerce
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

BigCommerce Channels API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Auth-Token (X-Auth-Token). By default, every request must be authenticated.

  • X-Auth-Token — OAuth scopes | UI Name | Permission | Parameter | |:--|:--|:-| | Information & Settings | read-only | storev2informationreadonly| | Information & Settings | mo…

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Channels 4
GET
/channels
BigCommerce Get All Channels
getChannels 14 params → 200422
POST
/channels
BigCommerce Create a Channel
createChannel 2 params body → 200422
GET
/channels/{channel_id}
BigCommerce Get a Channel
getChannel 3 params → 200404
PUT
/channels/{channel_id}
BigCommerce Update a Channel
updateChannel 3 params body → 200404409422

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are ChannelWithCurrencies (13 properties), ChannelWithoutCurrencies (12 properties), CreateChannelReq (8 properties), UpdateChannelReq (6 properties). Each schema is shown below with its type and property counts.

ChannelType
string
The type of channel; channel platform and type must be a [valid combination](/docs/rest-management/channelsstatus).
ErrorDetail
object
Error detail response payload for the BigCommerce API.
CreateChannelReq
object
8 properties 3 required
DefaultCurrency
string
Default currency for the channel in [ISO 4217](https://en.wikipedia.org/wiki/ISO4217) three character alphabetic format. Will be used on storefront when other…
ExternalId
string
Associated ID within a system / platform outside of BC.
EmptyMeta
object
Response metadata.
Error
object
Error response payload for the BigCommerce API.
4 properties
IsVisible
boolean
Indicates if a channel is visible within the BigCommerce merchant admin UI (control panel). If false, the channel will not show in Channel Manager nor in any c…
CurrencyNotRequiredWithChannelId
object
Details about currency assignments for a specific channel.
3 properties
ChannelDateModified
string
Date on which the channel was most recently changed.
pagination_Full
object
Data about the pagination.
6 properties
ChannelWithoutCurrencies
object
12 properties 2 required
IsListableFromUI
boolean
Indicates if a channel can create listings from the BigCommerce UI. Default value for this field is based on the channel type and platform combination if not s…
MetaWithFullPagination
object
Data about the response, including pagination.
1 property
ChannelWithCurrencies
object
13 properties
ChannelId
integer
The ID of the channel.
ChannelDateCreated
string
Date on which the channel was first created.
IconUrl
string
Link to the platform icon.
UpdateChannelReq
object
6 properties
ChannelName
string
Name of the channel as it will appear in the store control panel. The only characters it can include are Latin alphabet letters, Arabic numerals, dashes, and u…
ChannelPlatform
string
The name of the platform for the channel; channel platform and type must be a [valid combination](/docs/rest-management/channelsstatus).
ChannelStatus
string
The status of the channel; channel type, platform, and status must be a [valid combination](/docs/rest-management/channelsstatus). terminated is not valid for…
ChannelConfigMeta
object
Optional channel configuration object.
1 property
EnabledCurrencies
array
Currencies that are enabled for the specified channel in [ISO 4217](https://en.wikipedia.org/wiki/ISO4217) three character alphabetic format.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bigcommerce-channels-api-openapi.yml Raw ↑

Other APIs BigCommerce publishes across the network.

Big Commerce Inventory
AE Profile APIs.io
Big Commerce Locations
AE Profile APIs.io
Big Commerce Customer Segmentation
AE Profile APIs.io
Big Commerce Promotions
AE Profile APIs.io
Big Commerce Promotion Settings
AE Profile APIs.io
Big Commerce Pickup Methods
AE Profile APIs.io
Big Commerce Storefront Pickup Options
AE Profile APIs.io
Big Commerce Transactions
AE Profile APIs.io
BigCommerce Abandoned Cart Emails API
AE Profile APIs.io
BigCommerce Abandoned Cart Settings API
AE Profile APIs.io
BigCommerce Abandoned Carts API
AE Profile APIs.io
BigCommerce Abandoned Carts Settings API
AE Profile APIs.io
#Channels
← Back to B APIs
API Details
ID
bigcommerce:bigcommerce-channels-api
Base URL
https://api.example.com
Docs
https://developer.bigcommerce.com/
Provider
BigCommerce
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=bigcommerce-channels-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/bigcommerce-channels-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of BigCommerce Channels API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.