Docs
Content API
Themes
Theme Configurations

Theme Configurations

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

Parameters

  • store_hash in path - string
  • uuid in path - string
    required
    The theme identifier.
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • uuid:in in query - array
    Filter configurations by passing a comma-separated list of configuration UUIDs.
    Type: array[string]
  • variation_uuid in query - string
    Filter configurations by a variation_uuid.
  • channel_id:in in query - array
    Filter configurations by passing a comma-separated list of channel IDs.
    Type: array[integer]
  • 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.

example

Response

Body

object | application/json

Response payload for the BigCommerce API.

  • data    array[object]

  • meta    object

    Response metadata.

response

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

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

Response

Theme passes validation.

Body

object | application/json

    example

    Did you find what you were looking for?
    Activate a ThemeGet Theme Configuration