WebstoreTemplateSchemaDto

Represents a template's schema, declared by its author: who maintains it, how it receives updates and the settings a store can configure without editing the template's files.

authorstringRequired

The name of the template's author.

configWebstoreTemplateSchemaSectionDto[]Required

The sections of settings the template exposes, in display order.

headerstringRequired

The heading shown above the section.

optionsWebstoreTemplateSchemaOptionDto[]Required

The settings in the section, in display order.

idstringRequired

The key the setting's value is stored under. Use it as the variable name when setting values through the schema variables endpoint.

namestringRequired

The label shown for the setting.

nested_optionsWebstoreTemplateSchemaOptionDto[]Required

The settings nested under this one. Empty when it has none.

→ WebstoreTemplateSchemaOptionDto

typestringRequired

The kind of control used to edit the setting (e.g., text, toggle, select, color).

valuesstring[]Required

The choices a select-style setting offers. Empty for other kinds of setting.

defaultnullOptional

The value used while the store has not set one, or null when there is no default.

descriptionstringOptional

A longer explanation of the setting, or null when the template gives none.

maxnumberOptional

The highest value a numeric setting accepts, or null when it is unbounded.

minnumberOptional

The lowest value a numeric setting accepts, or null when it is unbounded.

multilinebooleanOptional

Indicates whether a text setting accepts multiple lines, or null when it does not apply.

numericbooleanOptional

Indicates whether a text setting only accepts numbers, or null when it does not apply.

support_emailstringOptional

The email address to contact for support with the template, or null when none is given.

support_urlstringOptional

The URL to visit for support with the template, or null when none is given.

updatesWebstoreTemplateSchemaUpdatesDtoOptional

Represents how a template receives updates from its author.

github_branchstringRequired

The branch of the repository updates are pulled from.

supportedbooleanRequired

Indicates whether the template can be updated in place.

version_check_supportedbooleanRequired

Indicates whether the newest available version can be looked up before updating.

github_tokenstringOptional

The token used to read a private repository, or null when the repository is public.

github_urlstringOptional

The URL of the GitHub repository updates are pulled from, or null when updates do not come from GitHub.

versionstringOptional

The version of the template currently installed, or null when the template does not declare one.

Example

{
  "author": "string",
  "config": [
    {
      "header": "string",
      "options": [
        {
          "id": "string",
          "name": "string",
          "nested_options": [
            {}
          ],
          "type": "string",
          "values": [
            "string"
          ],
          "default": {},
          "description": "string",
          "max": 0,
          "min": 0,
          "multiline": true,
          "numeric": true
        }
      ]
    }
  ],
  "support_email": "string",
  "support_url": "string",
  "updates": {
    "github_branch": "string",
    "supported": true,
    "version_check_supported": true,
    "github_token": "string",
    "github_url": "string",
    "version": "string"
  }
}