Widget
Create a Widget
POST https://api.bigcommerce.com/stores/{store_hash}/v3/content/widgetsRequest
Creates a Widget.
Note: There is a limit of 100,000 widgets per store and 150 widgets per page. For more information, see Store Limits.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
object | application/json
namestring
requiredUser friendly name.
descriptionstring
The user-friendly description.
channel_idinteger
The ID of the channel on which to create this widget. Defaults to the first channel created on the store.
example
Response
Body
object | application/json
data
response
Get All Widgets
GET https://api.bigcommerce.com/stores/{store_hash}/v3/content/widgetsRequest
Returns a list of Widgets. Optional parameters can be passed in.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Body
object | application/json
dataarray[]
response
Get a Widget
GET https://api.bigcommerce.com/stores/{store_hash}/v3/content/widgets/{uuid}Request
Returns a single Widget.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Body
object | application/json
data
response
Update a Widget
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/content/widgets/{uuid}Request
Updates a Widget.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
application/json
example
Response
Body
object | application/json
data
response
Delete a Widget
DELETE https://api.bigcommerce.com/stores/{store_hash}/v3/content/widgets/{uuid}Request
Deletes a Widget.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
An empty response.
Did you find what you were looking for?