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

BigCommerce Products API

The Products API from BigCommerce — 3 operation(s) for products.

BigCommerce Products 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 Product. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 8 operations across 3 paths, and defines 34 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.

8 operations 3 paths 34 schemas 2 DELETE2 GET2 POST2 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
Terms of Service
Resource Areas
1

Authentication & Security 1

BigCommerce Products 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 8

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

Products 8
GET
/catalog/products
BigCommerce Get All Products
getProducts 51 params → 200
PUT
/catalog/products
BigCommerce Update Products (Batch)
updateProducts 3 params body → 200207404409413422
POST
/catalog/products
BigCommerce Create a Product
createProduct 3 params body → 200207409422
DELETE
/catalog/products
BigCommerce Delete Products
deleteProducts 17 params → 204
GET
/catalog/products/{product_id}
BigCommerce Get a Product
getProduct 5 params → 200404
PUT
/catalog/products/{product_id}
BigCommerce Update a Product
updateProduct 4 params body → 200201207404409422
DELETE
/catalog/products/{product_id}
BigCommerce Delete a Product
deleteProduct 2 params → 204
POST
/pricing/products
BigCommerce Get Prices (Batch)
getPrices body → 200

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are product_Base (67 properties), config_Full (24 properties), productOptionConfig_Full (24 properties), productVariant_Base (18 properties). Each schema is shown below with its type and property counts.

productVideo_Full
A product video model.
BulkPricingTier
object
5 properties
productImage_Full
Common ProductImage properties.
metaEmpty_Full
object
Response metadata.
productImage_Base
object
Common ProductImage properties.
5 properties
productVariantOptionValue_Full
2 required
productModifier_Full
Product Modifier
pagination_Full
object
Data about the response, including pagination and collection totals.
6 properties
productVariant_Base
object
Common Variant properties.
18 properties
adjuster_Full
object
Adjuster for Complex Rules.
2 properties
errorResponse_409
metaCollection_Full
object
Data about the response, including pagination and collection totals.
1 property
productVariant_Full
3 required
product_Put_Collection
array
The model for batch updating products.
productModifierOptionValue_Base
object
Common Product Modifer optionvalue properties.
5 properties 2 required
productOption_Base
object
Common Option properties.
7 properties
productVideo_Base
object
The model for a POST to create a video on a product.
5 properties
productModifier_Base
object
Common Modifier properties.
5 properties 2 required
errorMultiStatus
object
4 properties
product_Base
object
Shared Product properties used in: POST PUT GET
67 properties 4 required
customUrl_Full
object
The custom URL for the product on the storefront.
3 properties
productModifierOptionValue_Full
Product Modifer optionvalue.
productOptionOptionValue_Full
Product Option optionvalue.
config_Full
object
The values for option config can vary based on the Modifier created.
24 properties
productCustomField_Put
object
The model for a PUT to update a custom field on a product.
3 properties 2 required
adjusters_Full
object
4 properties
product_Put
The model for a PUT to update a product.
productOptionOptionValue_Base
object
Common Product Option optionvalue properties.
4 properties 2 required
errorResponse_422
productOptionConfig_Full
object
The values for option config can vary based on the Modifier created.
24 properties
product_Full
bulkPricingRule_Full
object
Common Bulk Pricing Rule properties
4 properties 4 required
DetailedErrors
object
Each key-value pair describes a failure or partial success case.
error_Base
object
Error payload for the BigCommerce API.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bigcommerce-products-api-openapi.yml Raw ↑

Other APIs BigCommerce publishes across the network.

Big Commerce Inventory
Big Commerce Locations
Big Commerce Customer Segmentation
Big Commerce Promotions
Big Commerce Promotion Settings
Big Commerce Pickup Methods
Big Commerce Storefront Pickup Options
Big Commerce Transactions
BigCommerce Abandoned Cart Emails API
BigCommerce Abandoned Cart Settings API
BigCommerce Abandoned Carts API
BigCommerce Abandoned Carts Settings API
Where this information came from

This is an independent, third-party profile of BigCommerce Products 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.