BigCommerce Listings 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 Listings. 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 28 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 operations2 paths28 schemas2 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
BigCommerce Listings 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.
Listings 4
GET
/channels/{channel_id}/listings
BigCommerce Get Channel Listings
getChannelListings11 params→ 200400422
POST
/channels/{channel_id}/listings
BigCommerce Create Channel Listings
createChannelListings3 paramsbody→ 200422
PUT
/channels/{channel_id}/listings
BigCommerce Update Channel Listings
updateChannelListings3 paramsbody→ 200422
GET
/channels/{channel_id}/listings/{listing_id}
BigCommerce Get a Channel Listing
getChannelListing3 params→ 200404
Schemas 28
The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are Listing (10 properties), ChannelProductVariantFull (9 properties), UpsertListingWithListingIdReq (7 properties), ChannelProductVariantPartial (6 properties). Each schema is shown below with its type and property counts.
ErrorDetail
object
Error detail response payload for the BigCommerce API.
ChannelProductVariantName
string
Name of the product variant for this channel listing specifically. This is an optional field that can be used to override the name of the product variant in th…
ChannelListingVariantDateCreated
string
Date on which the channel listing variant was first created.
ExternalId
string
Associated ID within a system / platform outside of BC.
Listing
object
10 properties
EmptyMeta
object
Response metadata.
ChannelProductMultipleVariants
array
Error
object
Error response payload for the BigCommerce API.
4 properties
CreateMultipleListingsReq
array
VariantState
string
The state of the channel listing variant.
ChannelListingDateCreated
string
Date on which the channel listing was first created.
ChannelProductName
string
Name of the product for this channel listing specifically. This is an optional field that can be used to override the product name in the catalog.
ListingId
integer
The ID of the channel listing that has been created, returned, or updated. In a 422 error, you may receive a response that references the groupid. The groupid…
ChannelListingVariantDateModified
string
Date on which the channel listing variant was most recently changed.
VariantId
integer
The ID of the product variant associated with this channel listing.
ChannelListingDateModified
string
Date on which the channel listing was most recently changed.
ListingState
string
The state of the product assignment or channel listing.
ChannelIdForListing
integer
The ID of the channel associated with this channel listing.
ProductId
integer
The ID of the product associated with this channel listing.
ChannelProductVariantDescription
string
Description of the product variant for this channel listing specifically. This is an optional field that can be used to override the description of the product…
pagination_Partial
object
Data about the pagination.
4 properties
MetaWithPartialPagination
object
Data about the response, including pagination.
1 property
ChannelProductDescription
string
Description of the product for this channel listing specifically. This is an optional field that can be used to override the product description in the catalog.
UpsertListingWithoutListingIdReq
object
Details about assigning a product to a specific channel.
6 properties3 required
ChannelProductVariantPartial
object
Details about a variant of the product for this channel listing.
6 properties3 required
UpdateMultipleListingsReq
array
UpsertListingWithListingIdReq
object
Details about assigning a product to a specific channel.
7 properties4 required
ChannelProductVariantFull
object
Details about a variant of the product for this channel listing.
9 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
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.
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 Listings 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.
