Scripts
Add client-side code to a BigCommerce storefront page or associate a script with a channel. To learn more about scripts, see the Scripts API article.
Create a Script
POST https://api.bigcommerce.com/stores/{store_hash}/v3/content/scriptsRequest
Creates a Script.
Required Fields
- name
Read Only Fields
- uuid
Limits
- 50 scripts per channel.
Notes
- If the
kind
issrc
:- Specify the
src
property. - Optionally, you can supply a
load_method
. - Do not specify the
html
field.
- Specify the
- If the
kind
isscript_tag
:- Specify the
html
property. - Do not specify the
src
field.
- Specify the
- Each app can have 10 scripts installed.
- Multiple scripts can be created per call.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
Script Source URL
HTML Script Tag
Response
example
Get All Scripts
GET https://api.bigcommerce.com/stores/{store_hash}/v3/content/scriptsRequest
Returns a list of Scripts. Optional parameters can be passed in.
This operation will only return scripts generated by the API key and password used to create the script originally.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- page in query - integer
Specifies the page number in a limited (paginated) list of products.
- limit in query - integer
Controls the number of items per page in a limited (paginated) list of products.
- sort in query - string
Field name to sort the scripts by. Note: Since
id
increments when new scripts are added, you can use that field to sort by script create date.Allowed: name | description | date_created | date_modified
- direction in query - string
Sort direction. Acceptable values are:
asc
,desc
.Allowed: asc | desc
- channel_id:in in query - array
Filters list of scripts by the associated channel ID.
Type: array[integer]
example
Response
Body
dataarray[object]
example
Get a Script
GET https://api.bigcommerce.com/stores/{store_hash}/v3/content/scripts/{uuid}Request
Returns a single Script.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
example
Update a Script
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/content/scripts/{uuid}Request
Updates a Script.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
example
Response
example
Delete a Script
DELETE https://api.bigcommerce.com/stores/{store_hash}/v3/content/scripts/{uuid}Request
Deletes a Script.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Body
No-content response for the BigCommerce API.
statusinteger
204 HTTP status code.
Example: 204titlestring
The error title describing the situation.
typestring
instancestring