SiteRoutes
Creates, retrieves, updates, and deletes routes that link a headless storefront site to pages.
Table Specific Information
Select
The provider uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:
- SiteId supports the = comparison. A value for SiteId is required.
- Id supports the = comparison.
- Type supports the = comparison.
The rest of the filter is executed client-side within the provider.
For example, the following queries are processed server-side:
SELECT * FROM SiteRoutes WHERE SiteId = 10
SELECT * FROM SiteRoutes WHERE SiteId = 10 AND Id = 5
Insert
To insert a site route, specify SiteId, Type, Matching, and Route.
Note: Value for Matching field must be unique.
INSERT INTO SiteRoutes (SiteId, Type, Matching, Route) VALUES (10, 'product', '*', '/shop/{slug}')
Update
UPDATE SiteRoutes SET Route = '/store/{slug}' WHERE SiteId = 10 AND Id = 5
Delete
DELETE FROM SiteRoutes WHERE SiteId = 10 AND Id = 5
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | True |
The unique identifier of the route. |
| SiteId [KEY] | Integer | False |
The Id of the site this route belongs to. |
| Type | String | False |
The resource type this route resolves to. The allowed values are product, brand, category, page, blog, home, cart, checkout, search, account, login, returns, static. |
| Matching | String | False |
The Id of the specific resource this route matches, or * to match all resources of the given type. |
| Route | String | False |
The URL template for the route. Supports the {id}, {slug}, and {language} tokens. |