Docs
Content API
Themes

Themes

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

Get all Themes

GET /themes

Request

Returns a list of store Themes.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/themes' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Body

object | application/json

Response payload for the BigCommerce API.

  • data    array[object]

  • meta    object

    Response metadata.

response

{
"data": [
{
"uuid": "872b3e20-731f-0136-9d2f-633ff0d6ced1",
"variations": [
{
"uuid": "877427a0-731f-0136-9d2f-633ff0d6ced1",
"name": "Light",
"description": "Ideal for a wide range of businesses and brands, this design is fully responsive, simple, and ready for you to add your branding, logo, and products. It comes ready to build a clean looking and beautiful store with features such as homepage carousel, social media icons, featured and top selling products, and faceted search (which is available on select BigCommerce plans). Fully express your brand by using our Theme Editor to quickly and easily style your site’s fonts and colors, all without the need to write code.",
"external_id": "light"
},
{
"uuid": "87be3180-731f-0136-9d2f-633ff0d6ced1",
"name": "Bold",
"description": "Ideal for a wide range of businesses and brands, this design is fully responsive, simple, and ready for you to add your branding, logo, and products. It comes ready to build a clean looking and beautiful store with features such as homepage carousel, social media icons, featured and top selling products, and faceted search (which is available on select BigCommerce plans). Fully express your brand by using our Theme Editor to quickly and easily style your site’s fonts and colors, all without the need to write code.",

Upload a Theme

POST /themes

Request

Uploads a new Theme to your BigCommerce store.

Required Fields

  • file

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

object | multipart/form-data

  • file    string
    required

    The file.

Response

Job ID for the background job processing the theme upload.

Body

object | application/json
The job identifier for theme upload or download.

  • job_id    string

    The job identifier.

response

{
"job_id": "ceea1917b1518f5ae491da6ad8a56336"
}

Get a Theme

GET /themes/{uuid}

Request

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

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • uuid in path - string
    required
    The theme identifier.

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/themes/[uuid]' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Body

object | application/json

Response payload for the BigCommerce API.

  • data    object

    A theme.

  • meta    object

    Response metadata.

response

{
"data": {
"uuid": "e3d82ce0-9bae-0133-0de7-525400970412",
"variations": [
{
"uuid": "b16c3fe0-7bcb-0136-b5fc-07fe54a9e639",
"name": "Light",
"description": "Ideal for a wide range of businesses and brands, this design is fully responsive, simple, and ready for you to add your branding, logo, and products. It comes ready to build a clean looking and beautiful store with features such as homepage carousel, social media icons, featured and top selling products, and faceted search (which is available on select BigCommerce plans). Fully express your brand by using our Theme Editor to quickly and easily style your site’s fonts and colors, all without the need to write code.",
"external_id": "light"
},
{
"uuid": "b17d57e0-7bcb-0136-b5fc-07fe54a9e639",
"name": "Bold",
"description": "Ideal for a wide range of businesses and brands, this design is fully responsive, simple, and ready for you to add your branding, logo, and products. It comes ready to build a clean looking and beautiful store with features such as homepage carousel, social media icons, featured and top selling products, and faceted search (which is available on select BigCommerce plans). Fully express your brand by using our Theme Editor to quickly and easily style your site’s fonts and colors, all without the need to write code.",

Delete a Theme

DELETE /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 header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • uuid in path - string
    required
    The theme identifier.

example

curl --request DELETE \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/themes/[uuid]' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?
Get a Count of RedirectsGet all Themes