The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.

Accept

The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body.

Content-Type

job_id

Controls the number of items per page in a limited (paginated) list of products.


limit

Specifies the page number in a limited (paginated) list.


page

uuid

Response payload for the BigCommerce API.


Request definition for activation endpoint.

The identifier for the variation to activate.

Activate

The error title describing the particular error.


Base Error

Data about the response, including pagination and collection totals.

Total number of items in the collection response.


The page you are currently on within the collection.


Pagination links for the previous and next parts of the whole collection.


The amount of items returned in the collection per page, controlled by the limit parameter.


Total number of items in the result set.


The total number of pages in the collection.


Pagination

Collection Meta

Detailed Errors

Error Response

The job identifier for theme upload or download.

Job Id

Job Response

No-content response for the BigCommerce API.

The error title describing the situation.

No Content

The error title describing the particular error.

Not Found

Response meta

Link to the current page returned in the response.


Link to the next page returned in the response.


Link to the previous page returned in the response.


These are the minium request headers needed for BigCommerce. 

Request Headers

Theme Response

Themes Collection Meta

Themes Collection Response

A BigCommerce object specifying which theme to download.

`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`.

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.

Which Theme To Download

Site ID to which this configuration belongs. Will be 0 for the original configuration for a Theme.

The Theme to which the Configuration belongs.

The Variation to which the Configuration belongs.

themeConfiguration_Full

themeConfiguration_Write

### OAuth scopes

| UI Name | Permission | Parameter |
|:--------|:-----------|:----------|
|  Themes | modify | `store_themes_manage` |

### Authentication header

| Header | Argument | Description |
|:-------|:---------|:------------|
| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). |

### Further reading

For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests).

For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes).

For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes).

X-Auth-Token

BigCommerce

Backup, restore, download, and activate themes; and, get the status of theme jobs and read theme configurations.

Themes

Uploads a new *Theme* to your BigCommerce store.

**Required Fields**
* file

Job ID for the background job processing the theme upload.

The ID for the channel where you want to activate the theme.

channel_id

Actives a store *Theme*.

This returns a 204 response upon success.

This returns when the request is successful.

Enumerate available custom templates for in the theme files in a specific theme version for each supported entity type.

version_uuid

Returns a theme *Job*. When the job is complete, the results array provides a generated link to access the theme. The link is active for 60 seconds.

Deletes a store *Theme*.
Theme variations can not be deleted using this endpoint. This will delete the theme and all variations.

Returns a store *Theme*. The theme variation is not available at this endpoint.

Job ID for the background job processing the download.

Returns a list of theme's configurations.

**Usage Notes**:
* At least one filter must be provided.

Filter configurations by passing a comma-separated list of configuration UUIDs.

uuid:in

Filter configurations by passing a comma-separated list of channel IDs.

channel_id:in

Filter configurations by a variation_uuid.

variation_uuid

Filter configurations by passing a comma-separated list of site IDs.

site_id:in

Filter configurations by a list of configuration UUIDs.

Filter configurations by a variation_uuid

Validates a theme configuration against the theme's schema without creating it. Useful for testing schemas before creation.

Theme failed validation, detailed errors in response.

Themes

Get Custom Templates

Request

Authentication

Parameters

example

Response

Body

dataobject

metaobject

Custom template 1