Widgets
- Host: api.bigcommerce.com/stores/store_hash/v3
- Protocols:
https - Accepts:
application/json - Responds With:
application/json
Create and manage widget templates, widgets, regions, and placements.
Authentication
Authenticate requests by including an OAuth access_token in the request header.
GET https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/{{ENDPOINT}}
Content-Type: application/json
X-Auth-Token: {{ACCESS_TOKEN}}
OAuth scopes
| UI Name | Permission | Parameter |
|---|---|---|
| Content | modify | store_v2_content |
| Content | read-only | store_v2_content_read_only |
For more information on OAuth scopes, see Authenticating BigCommerce’s REST APIs.
Subresources
Widget templates
Widget templates are reusable Handlebars-enabled HTML templates that define the structure of the widget on a page.
Widgets
Widgets are units of content placed on specific pages in a Stencil theme. Widgets consist of a widget configuration and a widget template UUID and render as part of the storefront’s HTML.
Regions
Regions are specific locations in the Stencil theme template files where you can place a widget.
Placements
Placements determine the region where you place widgets and in what order.