Themes
Backup, restore, download, and activate themes; and, get the status of theme jobs and read theme configurations.
Get all Themes
GET /stores/{store_hash}/v3/themes
Request
Returns a list of store Themes.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
example
Response
Body
Response payload for the BigCommerce API.
dataarray[object]
metaobject
Data about the response, including pagination and collection totals.
response
Upload a Theme
POST /stores/{store_hash}/v3/themes
Request
Uploads a new Theme to your BigCommerce store.
Required Fields
- file
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.
Response
Job ID for the background job processing the theme upload.
Body
The job identifier for theme upload or download.
job_idstring
The job identifier.
response
Get a Theme
GET /stores/{store_hash}/v3/themes/{uuid}
Request
Returns a store Theme. The theme variation is not available at this endpoint.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
- uuid in path - stringrequired
The theme identifier.
example
Response
Body
Response payload for the BigCommerce API.
dataobject
A theme.
metaobject
Data about the response, including pagination and collection totals.
response
Delete a Theme
DELETE /stores/{store_hash}/v3/themes/{uuid}
Request
Deletes a store Theme. Theme variations can not be deleted using this endpoint. This will delete the theme and all variations.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
- uuid in path - stringrequired
The theme identifier.