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

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

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

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

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

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

Response

Did you find what you were looking for?