Themes
Download a Theme
POST /stores/{store_hash}/v3/themes/{uuid}/actions/download
Request
Downloads a stores Theme.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
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.
whichstring
Which revision to use.
Allowed: original | last_activated | last_created
example
Response
Job ID for the background job processing the download.
Body
The job identifier for theme upload or download.
job_idstring
The job identifier.
response
Activate a Theme
POST /stores/{store_hash}/v3/themes/actions/activate
Request
Actives a store Theme.
This returns a 204 response upon success.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- channel_id in query - integer
The ID for the channel where you want to activate the theme.
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Request parameters.
Body
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
Response
This returns when the request is successful.
Body
No-content response for the BigCommerce API.
statusinteger
204 HTTP status code.
titlestring
The error title describing the situation.
typestring
instancestring