Scripts

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

Inject client-side code onto a BigCommere storefront. 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 to create or read scripts on the checkout page.

For more information on OAuth Scopes, see: Authentication.

Authentication

Requests can be authenticated by sending anaccess_token via X-Auth-Token HTTP header:

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