Themes
Get Theme Configuration
GET /stores/{store_hash}/v3/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 headerrequired
Parameters
- store_hash in path - string
- site_id:in in query - arrayrequired
Filter configurations by passing a comma-separated 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 - stringrequired
The theme identifier.
- uuid:in in query - array
Filter configurations by passing a comma-separated list of configuration UUIDs.
- channel_id:in in query - array
Filter configurations by passing a comma-separated 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
Response
Body
Response payload for the BigCommerce API.
dataarray[object]
metaobject
Data about the response, including pagination and collection totals.
response
Validate Theme Configuration
POST /stores/{store_hash}/v3/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 headerrequired
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
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
Response
Theme passes validation.