Theme Actions
Download a Theme
POST https://api.bigcommerce.com/stores/{store_hash}/v3/themes/{uuid}/actions/downloadRequest
Downloads a stores Theme.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- uuid in path - stringrequiredThe theme identifier.
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
Body
object | application/json
An object specifying which theme to download. One of:
original
: the original Marketplace or uploaded custom theme; last_activated
: the theme version most recently applied to the store; last_created
: the theme version most recently created. If which
is missing or invalid in the request, its value will default to last_activated
.whichstring
Which revision to use.Allowed: original | last_activated | last_created
Example: original
example
{
"which": "original"
}
Response
Job ID for the background job processing the download.
Body
object | application/json
The job identifier for theme upload or download.
job_idstring
The job identifier.
response
{
"job_id": "ceea1917b1518f5ae491da6ad8a56336"
}
Activate a Theme
POST https://api.bigcommerce.com/stores/{store_hash}/v3/themes/actions/activateRequest
Actives a store Theme.
This returns a 204 response upon success.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- channel_id in query - integerThe ID for the channel where you want to activate the theme.
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
Request parameters.
Body
object | application/json
Request definition for activation endpoint.
variation_idstring
requiredThe identifier for the variation to activate.whichstring
Which configuration to use.Allowed: original | last_activated | last_created
example
{
"variation_id": "string",
"which": "original"
}
Response
This returns when the request is successful.
Body
object | application/json
No-content response for the BigCommerce API.
statusinteger
204 HTTP status code.
titlestring
The error title describing the situation.typestring
instancestring
example
{
"status": 0,
"title": "string",
"type": "string",
"instance": "string"
}
Did you find what you were looking for?