BigCommerce
Theme & Content APIs
Theme Actions

Themes

Download a Theme

POST /themes/{uuid}/actions/download

Request

Downloads a stores Theme.

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.

Body

object | application/json

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
    string

    Which revision to use.

    Allowed: original | last_activated | last_created

    example

    Response

    Job ID for the background job processing the download.

    Body

    object | application/json

    The job identifier for theme upload or download.

    • job_id
      string

      The job identifier.

    response

    Activate a Theme

    POST /themes/actions/activate

    Request

    Actives a store Theme.

    This returns a 204 response upon success.

    Authentication

    • X-Auth-Token in header
      required

    Parameters

    • store_hash in path - string
    • channel_id in query - integer

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

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

      The MIME type of the request body.

    Request parameters.

    Body

    application/json

    Request definition for activation endpoint.

    • variation_id
      string
      required

      The identifier for the variation to activate.

    • which
      string

      Which configuration to use.

      Allowed: original | last_activated | last_created

    example

    Response

    This returns when the request is successful.

    Body

    object | application/json

    No-content response for the BigCommerce API.

    • status
      integer

      204 HTTP status code.

    • title
      string

      The error title describing the situation.

    • type
      string

    • instance
      string

    example

    Did you find what you were looking for?