Sites

Create and manage sites and routes for headless storefront sales channels.

Note: For the “urls” object, we no longer modify the www prefix of the primary URL. The API returns URLs exactly as the customer enters them, similar to the “url” field.

If the customer saves a URL with www, the API returns it with www.
If the customer saves a URL without www, the API returns it without www.

Sites

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

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

Response

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

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

1 GET https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/sites
2 X-Auth-Token: {{ACCESS_TOKEN}}
3 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.

1 POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/sites/{site_id}/routes
2 X-Auth-Token: {{ACCESS_TOKEN}}
3 Content-Type: application/json
4 Accept: application/json
5 
6 {
7   "type": "product",
8   "matching": "12",
9   "route": "/en/product?id=12"
10 }

Route types

The following route types are supported.

Type	Description
`product`	Route for product details pages
`brand`	Route to brand pages
`category`	Route to category pages
`blog`	Route to blog page
`home`	Route to storefront homepage
`cart`	Route to shopper’s cart
`checkout`	Route to checkout page
`search`	Route to store search page
`account`	Route to account profile page
`login`	Route to account login page
`returns`	Route for return policy page
`static`	Route to a static page
`create_account`	Route to create new shopper account page
`forgot_password`	Route to shopper forgot password page
`account_order_status`	Route for order status page
`account_new_return`	Route for product returns page
`recover_abandoned_cart`	Route for URL in emails for a shopper to recover their abandoned cart

Route variables

The following route variables are supported.

Variable	Description
`{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:

1 POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/sites/{site_id}/routes
2 X-Auth-Token: {{ACCESS_TOKEN}}
3 Content-Type: application/json
4 Accept: application/json
5 
6 {
7   "type": "product",
8   "matching": "*",
9   "route": "/{lang}/{slug}?id={id}"
10 }

Additional Information

Create and manage sites and routes for headless storefront sales channels.

Note: For the “urls” object, we no longer modify the www prefix of the primary URL. The API returns URLs exactly as the customer enters them, similar to the “url” field.

If the customer saves a URL with www, the API returns it with www.
If the customer saves a URL without www, the API returns it without www.

Sites

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

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

Response

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

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

1 GET https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/sites
2 X-Auth-Token: {{ACCESS_TOKEN}}
3 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.

1 POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/sites/{site_id}/routes
2 X-Auth-Token: {{ACCESS_TOKEN}}
3 Content-Type: application/json
4 Accept: application/json
5 
6 {
7   "type": "product",
8   "matching": "12",
9   "route": "/en/product?id=12"
10 }

Route types

The following route types are supported.

Type	Description
`product`	Route for product details pages
`brand`	Route to brand pages
`category`	Route to category pages
`blog`	Route to blog page
`home`	Route to storefront homepage
`cart`	Route to shopper’s cart
`checkout`	Route to checkout page
`search`	Route to store search page
`account`	Route to account profile page
`login`	Route to account login page
`returns`	Route for return policy page
`static`	Route to a static page
`create_account`	Route to create new shopper account page
`forgot_password`	Route to shopper forgot password page
`account_order_status`	Route for order status page
`account_new_return`	Route for product returns page
`recover_abandoned_cart`	Route for URL in emails for a shopper to recover their abandoned cart

Route variables

The following route variables are supported.

Variable	Description
`{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:

1 POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/sites/{site_id}/routes
2 X-Auth-Token: {{ACCESS_TOKEN}}
3 Content-Type: application/json
4 Accept: application/json
5 
6 {
7   "type": "product",
8   "matching": "*",
9   "route": "/{lang}/{slug}?id={id}"
10 }

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

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

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

Sites

Site routes

Route types

Route variables

Additional Information

Related resources

Sites

Site routes

Route types

Route variables

Additional Information

Related resources