WebstoreTemplateVariableDto

Represents a value a template's files can reference, letting a store customise a template without editing its files.

idFlakeIdRequired

created_atstringRequired

The date and time the variable was created.

namestringRequired

The label shown for the variable in the editor.

template_idFlakeIdRequired

typeenumRequired

Specifies how a template variable's 'value' is interpreted when the template renders.

Possible enum values

invalid
No type specified. This value is typically used as a default or uninitialized state.
string
The value is used as plain text.
html
The value is inserted as raw HTML without escaping.
number
The value is parsed as a number.
boolean
The value is parsed as a boolean; 'true' is true, anything else is false.
json
The value is parsed as a JSON document.

updated_atstringRequired

The date and time the variable was last updated.

valuestringRequired

The value of the variable, always stored as a string and parsed according to 'type' when the template renders.

variablestringRequired

The name the template's files reference the value by.

webstore_idFlakeIdRequired

Example

{
  "id": "411486491630370816",
  "created_at": "2024-01-01T00:00:00Z",
  "name": "string",
  "template_id": "411486491630370816",
  "type": "invalid",
  "updated_at": "2024-01-01T00:00:00Z",
  "value": "string",
  "variable": "string",
  "webstore_id": "411486491630370816"
}