PayNow

WebstoreTemplateSchemaOptionDto

Represents one configurable setting in a template's schema.

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.
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.
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.
Example
{
  "id": "string",
  "name": "string",
  "nested_options": [
    {
      "id": "string",
      "name": "string",
      "nested_options": [
        {}
      ],
      "type": "string",
      "values": [
        "string"
      ],
      "default": {},
      "description": "string",
      "max": 0,
      "min": 0,
      "multiline": true,
      "numeric": true
    }
  ],
  "type": "string",
  "values": [
    "string"
  ],
  "default": {},
  "description": "string",
  "max": 0,
  "min": 0,
  "multiline": true,
  "numeric": true
}