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

Scripts

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

The BigCommerce Scripts API can be used to add a script to a store’s page. Some use cases:

  • Insert tracking codes
  • Storefront single click applications
  • Live chat, support plugins
  • Theme extension or connector apps

To learn more about Scripts, see here.

OAuth Scopes

UI Name Permission Parameter
Checkout Content1 modify store_content_checkout
Checkout Content1 read-only store_content_checkout_read_only
Content modify store_v2_content
Content read-only store_v2_content_read_only
  1. Checkout Content scopes are required for to create or read scripts on the checkout page.

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
Scripts Add client-side code to a store