Docs
Management API
Sites

Sites

Create and manage sites and routes for headless storefront (opens in a new tab) sales channels.

Sites

Sites link headless storefronts to sales channels. To create a site, send a POST request to /stores/{{STORE_HASH}}/v3/sites.

POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/sites
X-Auth-Token: {{ACCESS_TOKEN}}
Content-Type: application/json
Accept: application/json
 
{
  "url": "http://store.example.com/",
  "channel_id": 5
}

Response

{
  "id": 1,
  "url": "http://store.example.com/",
  "channel_id": 5,
  "created_at": "2022-01-04T04:15:50.000Z",
  "updated_at": "2022-01-04T04:15:50.000Z"
}

To get a list of sites, send a GET request to /stores/{{STORE_HASH}}/v3/sites.

GET https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/sites
X-Auth-Token: {{ACCESS_TOKEN}}
Accept: application/json

Site routes

Site routes tell BigCommerce how to link to pages on a headless storefront. To create a route for a site, send a POST request to /stores/{{STORE_HASH}}/v3/sites/{site_id}/routes.

POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/sites/{site_id}/routes
X-Auth-Token: {{ACCESS_TOKEN}}
Content-Type: application/json
Accept: application/json
 
{
  "type": "product",
  "matching": "12",
  "route": "/en/product?id=12"
}

Route types

The following route types are supported.

TypeDescription
productRoute for product details pages
brandRoute to brand pages
categoryRoute to category pages
blogRoute to blog page
homeRoute to storefront homepage
cartRoute to shopper’s cart
checkoutRoute to checkout page
searchRoute to store search page
accountRoute to account profile page
loginRoute to account login page
returnsRoute for return policy page
staticRoute to a static page
create_accountRoute to create new shopper account page
forgot_passwordRoute to shopper forgot password page
account_order_statusRoute for order status page
account_new_returnRoute for product returns page
recover_abandoned_cartRoute for URL in emails for a shopper to recover their abandoned cart

Route variables

The following route variables are supported.

VariableDescription
{id}The ID of the requested item
{slug}The slug for the requested item (if available). Note: the slug value may contain / slash
{lang}The language string that the client is using

Example:

POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/sites/{site_id}/routes
X-Auth-Token: {{ACCESS_TOKEN}}
Content-Type: application/json
Accept: application/json
 
{
  "type": "product",
  "matching": "*",
  "route": "/{lang}/{slug}?id={id}"
}

Additional Information

Related resources

Create a Site

Loading...

Get Sites

Loading...

Get a Site

Loading...

Update a Site

Loading...

Delete a Site

Loading...

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?