Brands
Brand Images
Brand Metafields
Category Metafields
Category Images
Products
Product Bulk Pricing Rules
Product Complex Rules
Product Custom Fields
Product Images
Product Metafields
Product Modifiers
Product Modifier Values
Product Modifier Images
Product Options
Product Option Values
Product Reviews
Product Variants
Product Variants Metafields
Product Videos
Summary
Variants
Category
Webhooks

Subscribers

  • Version: 3.0
  • Host: api.bigcommerce.com/stores/{$$.env.store_hash}/v3
  • Protocols: https
  • Accepts: application/json
  • Responds With: application/json
More Info

OAuth Scopes

UI Name Permission Parameter
Customers modify store_v2_customers
Customers read-only store_v2_customers_read_only

Headers

Header Parameter Description
X-Auth-Client client_id Obtained by creating an API account or installing an app in a BigCommerce control panel.
X-Auth-Token access_token Obtained by creating an API account or installing an app in a BigCommerce control panel.

Example

GET /stores/{$$.env.store_hash}/v3/catalog/summary
host: api.bigcommerce.com
Content-Type: application/json
X-Auth-Client: {client_id}
X-Auth-Token: {access_token}
  • For more information on Authenticating BigCommerce APIs, see: Authentication.