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

Catalog APIs

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

The Catalog API manages products, brands and categories for a store. To learn more about the Catalog resources see Catalog Products and Categories.

OAuth Scopes

UI Name Permission Parameter
Products modify store_v2_products
Products read-only store_v2_products_read_only

For more information on OAuth Scopes, see: Authentication.

Authentication

Requests can be authenticated by sending a client_id and access_token via X-Auth-Client and X-Auth-Token HTTP headers:

GET /stores/{$$.env.store_hash}/v3/catalog/summary
host: api.bigcommerce.com
Accept: application/json
X-Auth-Client: {client_id}
X-Auth-Token: {access_token}
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.

For more information on Authenticating BigCommerce APIs, see: Authentication.

Available Endpoints

Resource / Endpoint Description
Brand Images Create and manage brand images
Brand Metafields Create and manage brand metafields
Brands Create and manage brands
Catalog Create and manage store categories, products, and brands
Categories Create and manage categorties
Category Images Create and manage category images
Category Metafields Create and manage category metafields
Product Bulk Pricing Rules Create and manage product bulk pricing rules
Product Complex Rules Create and manage product complex rules
Product Custom Fields Create and manage product custom fields
Product Images Create and manage product images
Product Metafields Create and manage product meta fields
Product Modifier Images Create and manage product modifer images
Product Modifier Values Create and manage product modifier values
Product Modifiers Create and manage product midifiers
Product Reviews Create and manage product reviews
Product Variant Option Values Create and manage product variant option values
Product Variant Options Create and manage product variant options
Product Variants Create and manage product variants
Product Videos Create and manage product videos
Products Create and manage products
ProductVariant Metafields Create and manage product meta flields
Variants Get and update all variants

Resources

Webhooks

Related Endpoints