settings_schema.json
The settings_schema.json file controls the configuration options and content in the Theme Editor under Theme Settings. All configuration values in the Theme Editor are stored in settings_data.json.
Location
The settings_schema.json file is located in the config directory:
└── theme
...
├── config
├── settings_data.json
└── settings_schema.json
Structure
The settings_schema.json file consists of an array of objects, each of which must have the following properties:
| Property | Description | Required |
|---|---|---|
name | Type of the configuration | Yes |
settings | Relevant configurations for settings | Yes |
The settings_schema.json file should follow this basic format:
[
{
"name": "Type",
"settings": [
...
]
},
...
]
As a JSON file, settings_schema.json must contain valid JSON content. Additionally, ensure that all necessary settings comply with the appropriate syntax.
Usage
When working with the settings_schema.json file, familiarize yourself with the following:
Setting Types
There are two types of settings:
| Type | Description |
|---|---|
| Input Settings | These settings store values configured by merchants |
| Sidebar Settings | These do not store values and cannot be configured. They describe controls, provide categorization, and enhance data entry precision |
Accessing Settings
Theme settings can be accessed through the settings object. For more information on syntax and considerations, refer to Settings.
Adding Theme Metadata
Theme metadata appears in the upper left corner of the Theme Editor and is also displayed in the theme store:
To add this metadata, include an object with the name theme_info in the settings_schema.json file. This object must include the following properties:
| Property | Description | Required |
|---|---|---|
name | The value must be theme_info | Yes |
theme_name | Name of the theme | Yes |
theme_version | Version of the theme | Yes |
theme_author | Author of the theme | Yes |
theme_documentation_url | URL for the theme documentation | Yes |
theme_support_url | URL for theme support | No |
theme_cover_img | Cover image displayed in the theme store | Yes |
theme_home_pc_preview_img | Preview image of the home page for PC in the theme store | Yes |
theme_home_mobile_preview_img | Preview image of the home page for mobile in the theme store | Yes |
theme_pdp_pc_preview_img | Preview image of the product detail page for PC in the theme store | Yes |
theme_pdp_mobile_preview_img | Preview image of the product detail page for mobile in the theme store | Yes |
refill_section_object | Indicates if the section object refill is enabled | Yes |
theme_type_version | Identifies the theme series | Yes |
refill_section_objectandtheme_type_versionare identifiers for OS2.1 themes. Missing these will cause theme issues.- Current OS2.1 themes include: Seed, Charm, Modern, and North. The OS2.1 label is also visible in the theme store.
For example:
[
{
"name": "Seed",
"theme_name": "Seed",
"theme_version": "1.0.0",
"theme_author": "Shopline",
"theme_documentation_url": "",
"theme_support_url": "",
"theme_cover_img": "",
"theme_home_pc_preview_img": "",
"theme_home_mobile_preview_img": "",
"theme_pdp_pc_preview_img": "",
"theme_pdp_mobile_preview_img": "",
"refill_section_object": true,
"theme_type_version": "OS_2.1"
},
...
]
