Sites
Creates, retrieves, updates, and deletes sites that link headless storefronts to sales channels.
Table Specific Information
Select
The add-in uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:
- Id supports the = operators
- ChannelId supports the = and IN operators.
The rest of the filter is executed client-side within the add-in.
For example, the following queries are processed server-side:
SELECT * FROM Sites WHERE Id = 1018
SELECT * FROM Sites WHERE ChannelId = 1234
Insert
To insert a site, specify the Url and ChannelId columns.
INSERT INTO Sites (Url, ChannelId) VALUES ('https://headless.example.com', 1234)
Update
Only the Url column can be updated after a site is created.
UPDATE Sites SET Url = 'https://updated.example.com' WHERE Id = 10
Delete
DELETE FROM Sites WHERE Id = 10
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | True |
The unique identifier of the site. |
| Url | String | False |
The URL of the site. |
| ChannelId | Integer | False |
The Id of the channel this site is associated with. Cannot be changed after the site is created. |
| IsCheckoutUrlCustomized | Boolean | True |
Whether the checkout URL for this site has been customized. |
| Urls | String | True |
All URLs that belong to the site, including primary, canonical, and checkout URLs. |
| CreatedAt | Datetime | True |
Date and time the site was created. |
| UpdatedAt | Datetime | True |
Date and time the site was last updated. |