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

Get Theme Configuration

GET /themes/{uuid}/configurations

Request

Returns a list of theme's configurations.

Usage Notes:

  • At least one filter must be provided.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • uuid in path - string - required
  • site_id:in in query - array - required

    Filter configurations by a list of site_ids

  • page in query - integer

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

  • limit in query - integer

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

  • uuid in path - string - required

    The theme identifier.

  • uuid:in in query - array

    Filter configurations by a list of configuration UUIDs.

  • channel_id:in in query - array

    Filter configurations by a list of channel_ids.

  • page in query - integer

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

  • limit in query - integer

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

  • variation_uuid in query - string

    Filter configurations by a variation_uuid.

example

curl --request GET \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v3/themes/[uuid]/configurations' \
  --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": "in",
      "theme_uuid": "amet Ut",
      "variation_id": "ut",
      "settings": {},
      "date_created": "ei",
      "site_id": 52736226
    }
  ],
  "meta": {
    "pagination": {
      "total": 36,
      "count": 36,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1,
      "links": {
        "previous": "nostrud in",
        "current": "?page=1&limit=50",
        "next": "in"
      }
    }
  }
}

Validate Theme Configuration

POST /themes/{uuid}/configurations/validate

Request

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

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

A theme.

  • variation_id    string

    The Variation to which the Configuration belongs.

  • settings    object

    The content of the configuration, which is a JSON object which will vary in structure from theme to theme.

example

{
  "variation_id": "string",
  "settings": {}
}

Response

Theme passes validation.

Body

object | application/json

    example

    {}