BigCommerce Sites & Routes API

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

Create and manage sites and routes for headless storefronts.

OAuth Scopes

UI Name Permission Parameter
Sites & Routes modify store_sites
Sites & Routess read-only store_sites_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
Channels Create and manage catalog listings and channels
Channel Site Manage sites and routing for headless storefronts
Channel Listings Manage catalog differences among different storefronts or marketplaces

Usage Notes

Sites and Site Routes:

  • Sites and routes control the paths that make up a headless storefront
  • Site refers to the domain associated with a channel
  • Routes point to the URLs for key pages on the headless storefront. They define where the homepage is, where the cart page is, etc.
  • Sites and routes ensure links point where they’re supposed to and sales are attributed correctly. For example, a shopper’s order confirmation email should link back to Storefront A, where they placed their order, not Storefront B, which they’ve never visited.

Resources

Related Endpoints