try out ↗

← API Index


/api/system/variables

Lists all personalization variables (%Variable%) that can be used in mails, SMS and content texts, with the groups they belong to. Aliases and descriptions come in the requested language; an alias that does not exist in that language falls back to the default (German) form, which resolves as well.

Parameters

Name Description Type
locale language of aliases, descriptions and group labels (de, en, es, fr, sl); default: the request's locale string
group optionally return only the group with this key (see VariableGroup.key) and its variables; default: all groups string
oo-rf optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml String
oo-auth optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. int

Response Types

Type Version Description
VariableGroup 1 A group of personalization variables sharing the same context (customer, item, order, ...). Groups are listed in the recommended display order.
Variable 1 A personalization variable: written as %alias% into a mail, SMS or content text, it is replaced by data of the addressed customer, an item, a date or a link when the text is used. Some aliases carry an id or amount argument, e.g. Artikel..Name - see the group's id_label.

OpenAPI

See variables.yaml

Referenced in skills