Thanks for being patient while we implement your feedback to improve the developer experience.

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 - required

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: xxxxxxxxxxxxxxxxx'

Response

Body

object | application/json

Response payload for the BigCommerce API.

  • data    array[object]

  • meta    object

    Data about the response, including pagination and collection totals.

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.",
          "external_id": "bold"
        },
        {
          "uuid": "87d48e90-731f-0136-9d2f-633ff0d6ced1",
          "name": "Warm",
          "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": "warm"
        }
      ],
      "name": "Cornerstone-blog",
      "is_private": true,
      "is_active": false
    },
    {
      "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.",
          "external_id": "bold"
        },
        {
          "uuid": "b18ad610-7bcb-0136-b5fc-07fe54a9e639",
          "name": "Warm",
          "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": "warm"
        }
      ],
      "name": "Cornerstone",
      "is_private": false,
      "is_active": true
    },
    {
      "uuid": "1242c920-a5a6-0133-a20e-525400970412",
      "variations": [
        {
          "uuid": "fec9fe60-7ede-0136-effe-0cbd49ed50aa",
          "name": "Minimal",
          "description": "Fortune is a standout theme for cutting-edge online stores. Customers will be transfixed by its striking hero area, which puts your imagery on full display, along with its sleek navigation and unique product grid. Ideal for small-to-medium-sized catalogs, Fortune has everything you need to command and convert shoppers.",
          "external_id": "minimal"
        },
        {
          "uuid": "fee26530-7ede-0136-effe-0cbd49ed50aa",
          "name": "Bright",
          "description": "Fortune is a standout theme for cutting-edge online stores. Customers will be transfixed by its striking hero area, which puts your imagery on full display, along with its sleek navigation and unique product grid. Ideal for small-to-medium-sized catalogs, Fortune has everything you need to command and convert shoppers.",
          "external_id": "bright"
        },
        {
          "uuid": "fef38820-7ede-0136-effe-0cbd49ed50aa",
          "name": "Contrast",
          "description": "Fortune is a standout theme for cutting-edge online stores. Customers will be transfixed by its striking hero area, which puts your imagery on full display, along with its sleek navigation and unique product grid. Ideal for small-to-medium-sized catalogs, Fortune has everything you need to command and convert shoppers.",
          "external_id": "contrast"
        },
        {
          "uuid": "ff085ab0-7ede-0136-effe-0cbd49ed50aa",
          "name": "Highlight",
          "description": "Fortune is a standout theme for cutting-edge online stores. Customers will be transfixed by its striking hero area, which puts your imagery on full display, along with its sleek navigation and unique product grid. Ideal for small-to-medium-sized catalogs, Fortune has everything you need to command and convert shoppers.",
          "external_id": "highlight"
        }
      ],
      "name": "Fortune",
      "is_private": false,
      "is_active": false
    }
  ],
  "meta": {}
}

Upload a Theme

POST /themes

Request

Uploads a new Theme to your BigCommerce store.

Required Fields

  • file

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string - required

    The MIME type of the request body.

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 - required

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: xxxxxxxxxxxxxxxxx'

Response

Body

object | application/json

Response payload for the BigCommerce API.

  • data    object

    A theme.

  • meta    object

    Data about the response, including pagination and collection totals.

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.",
        "external_id": "bold"
      },
      {
        "uuid": "b18ad610-7bcb-0136-b5fc-07fe54a9e639",
        "name": "Warm",
        "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": "warm"
      }
    ],
    "name": "Cornerstone",
    "is_private": false,
    "is_active": false
  },
  "meta": {}
}

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 - required

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: xxxxxxxxxxxxxxxxx'

Response