Theme Configurations
Get Theme Configuration
GET https://api.bigcommerce.com/stores/{store_hash}/v3/themes/{uuid}/configurationsRequest
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 - stringrequiredThe theme identifier.
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- uuid:in in query - arrayFilter configurations by passing a comma-separated list of configuration UUIDs.Type: array[string]
- variation_uuid in query - stringFilter configurations by a variation_uuid.
- channel_id:in in query - arrayFilter 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
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: {{token}}'
Response
Body
object | application/json
Response payload for the BigCommerce API.
dataarray[object]
response
{
"data": [
{
"uuid": "in",
"theme_uuid": "amet Ut",
"variation_id": "ut",
"settings": {},
"date_created": "ei",
"site_id": 52736226
}
],
"meta": {}
}
Validate Theme Configuration
POST https://api.bigcommerce.com/stores/{store_hash}/v3/themes/{uuid}/configurations/validateRequest
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 - stringrequiredThe MIME type of the response body.
- uuid in path - stringrequiredThe theme identifier.
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
Body
object | application/json
A theme.
variation_idstring
The Variation to which the Configuration belongs.settingsobject
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
{}
Did you find what you were looking for?