/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

(string) language of aliases, descriptions and group labels (de, en, es, fr, sl); default: the request's locale
(string) optionally return only the group with this key (see VariableGroup.key) and its variables; default: all groups🔗 variablegroup
(String) optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml
(int) 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.

Response Types

VariableGroup ยท Variable

VariableGroup (v1) docs

A group of personalization variables sharing the same context (customer, item, order, ...). Groups are listed in the recommended display order.

Fields (3)
#FieldTypeDescriptionLinks
0keystringgroup key, referenced by Variable.group, e.g. customer⬆ group🔗 variablegroup
1labelstringhuman-readable group name in the requested language
2needs_customerbooltrue if the variables only resolve in the context of an addressed customer

Data (15 records)

keylabelneeds_customer
customer →variables ⬆Customertrue
chelper →variables ⬆Customer: dates/tourstrue
item →variables ⬆Itemfalse
buy →variables ⬆Item: buy linkstrue
ticker →variables ⬆Tickerfalse
article →variables ⬆Articlefalse
order →variables ⬆Ordertrue
gs →variables ⬆Discount vouchertrue
link →variables ⬆Linkstrue
ag →variables ⬆Links (action groups)true
util →variables ⬆Date/timefalse
reldate →variables ⬆Relative datefalse
qr →variables ⬆QR code (bank transfer)true
tb →variables ⬆Text blocksfalse
mail →variables ⬆Mail (only filled in while sending)false

Variable (v1) docs

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.

Fields (4)
#FieldTypeDescriptionLinks
0keystringlanguage-independent key of the variable, e.g. customer.firstname
1groupstringkey of the variable group (see VariableGroup) this variable belongs to, e.g. customer⬆ group🔗 variablegroup
2aliasstringthe name to write between the percent signs, in the requested language, e.g. Vorname; parts mark an argument to fill in
3descriptionstringwhat the variable is replaced with, in the requested language

Data (121 records)

keygroupaliasdescription
customer.openercustomer →variables ⬆AppellationAppellation of Customer (Mr./Mrs., Title)
customer.citycustomer →variables ⬆CityAddress/City of Customer
customer.dcitycustomer →variables ⬆City-DeliveryAddress/City (for delivery)
customer.countrycustomer →variables ⬆CountryCountry of Customer
customer.accountcustomer →variables ⬆CreditCurrent Credit Balance
customer.idcustomer →variables ⬆CustomerNumber
customer.emailcustomer →variables ⬆EmailAddress/Email of Customer
customer.firstnamecustomer →variables ⬆FirstnameFirstname of Customer
customer.mobilecustomer →variables ⬆MobileMobile Number of Customer
customer.namecustomer →variables ⬆NameLast Name of Customer
customer.dnamecustomer →variables ⬆Name-DeliveryAddress/Last Name (for Delivery)
customer.phonecustomer →variables ⬆PhonePhone Number of Customer
customer.salutationcustomer →variables ⬆SalutationSalutation (Dear Mrs. ...)
customer.streetcustomer →variables ⬆StreetAddress/Street of Customer
customer.dstreetcustomer →variables ⬆Street-DeliveryAddress/Street (Delivery)
customer.tourcustomer →variables ⬆Tour(first) Tour of customer
customer.zipcustomer →variables ⬆ZipAddress/Zip
customer.dzipcustomer →variables ⬆Zip-DeliveryAddress/ZIP (Delivery)
chelper.nextdaynotechelper →variables ⬆DeliveryRemarkNDayDelivery remark for next delivery day
chelper.nextdelnotechelper →variables ⬆DeliveryRemarkNTourDelivery remark for next tour
chelper.nextdate.shortDatechelper →variables ⬆NDeliveryDateNext delivery date
chelper.nextdate.longDatechelper →variables ⬆NDeliveryDateLongNext delivery date, long form
chelper.nextosh.shortDatechelper →variables ⬆NOrderDeadlineOrder deadline for next date
chelper.nextosh.longDatechelper →variables ⬆NOrderDeadlineLong
chelper.nextosh.longDateTimechelper →variables ⬆NOrderDeadlineLongTimeOrder deadline (long form)
chelper.nextosh.Timechelper →variables ⬆NOrderDeadlineTimeOrder deadline for next date, time only
chelper.nextosh.Weekdaychelper →variables ⬆NOrderDeadlineWeekdayOrder deadline for next date, weekday only
chelper.nexttourchelper →variables ⬆NTourName of tour for next date
chelper.nextnotechelper →variables ⬆NoteNTourTour note for next tour
chelper.placenotechelper →variables ⬆PlacementNotePlacement note of the (first) delivery address
chelper.tourdaychelper →variables ⬆TourDayfirst regular delivery day
chelper.tourdaylcchelper →variables ⬆TourDayLCfirst delivery day, lower case
item.b_startitem →variables ⬆Item.<no>.StartOfOrderItem.<no>.StartOfOrder (Start Order Period)
item.verbanditem →variables ⬆Item.AssociationItem.<no>.Association
item.buylinkitem →variables ⬆Item.BuyNowItem.<Number>.BuyNow (adds to cart), HTML link
item.buyurlitem →variables ⬆Item.BuyNowLinkItem.<Number>.BuyNowLink (adds to cart), plain URL
item.hklasseitem →variables ⬆Item.ClassItem.<no>.Class (Quality Class)
item.itextitem →variables ⬆Item.DescriptionItem.<no>.Description
item.eanitem →variables ⬆Item.EANItem.<no>.EAN
item.itemnameitem →variables ⬆Item.ENameItem.<no>.EName (item name, HTML-encoded)
item.b_endeitem →variables ⬆Item.EndOfOrderItem.<no>.EndOfOrder (End Order Period)
item.thumbitem →variables ⬆Item.IconItem.<no>.Icon
item.infotxtitem →variables ⬆Item.InfotextItem.<no>.Infotext (Short Info)
item.infourlitem →variables ⬆Item.InfourlItem.<no>.Infourl
item.nameitem →variables ⬆Item.NameItem.<no>.Name
item.imageitem →variables ⬆Item.PictureItem.<no>.Picture
item.image1item →variables ⬆Item.Picture1Item.<no>.Picture1 (block display)
item.bildurlitem →variables ⬆Item.PictureUrlItem.<no>.PictureUrl
item.priceitem →variables ⬆Item.PriceItem.<no>.Price
item.localizedPriceitem →variables ⬆Item.PriceFormattedItem.<no>.PriceFormatted
item.thumburlitem →variables ⬆Item.ProxyIconUrl
item.imageurlitem →variables ⬆Item.ProxyPictureUrlItem.<no>.ProxyPictureUrl
item.herkunftitem →variables ⬆Item.SourceItem.<no>.Source
item.tumbnailurlitem →variables ⬆Item.ThumbnailUrlItem.<no>.ThumbnailUrl
item.viewlinkitem →variables ⬆Item.ViewNowItem.<Number>.ViewNow, HTML link to the item page (no cart)
item.viewurlitem →variables ⬆Item.ViewNowLinkItem.<Number>.ViewNowLink, plain URL to the item page (no cart)
item.rendered1item →variables ⬆Item.html1Item.<no>.html1 (HTML div structure)
item.rendered2item →variables ⬆Item.html2Item.<no>.html2 (HTML table structure)
item.rendered3item →variables ⬆Item.html3Item.<no>.html3 (HTML table structure with image size)
item.rendered4item →variables ⬆Item.html4Item.<no>.html4 (HTML table structure with image size, buy link)
buy.linkbuy →variables ⬆Item.BuyItem.<Number>.Buy (adds to cart)
buy.linktextbuy →variables ⬆Item.BuyLinkItem.<Number>.BuyLink
buy.multihtmlbuy →variables ⬆Item.BuyMultipleItem.BuyMultiple.<No1>.<Amount1>.<Unit1>.<No2>.<Amount2>.<Unit2>... (Add multiple items to cart), HTML link
buy.multiurlbuy →variables ⬆Item.BuyMultipleLinkItem.BuyMultipleLink.<No1>.<Amount1>.<Unit1>.<No2>.<Amount2>.<Unit2>... (Add multiple items to cart), plain URL
buy.gobuy →variables ⬆Item.ShowItem.<Number>.Show
ticker.rendered1ticker →variables ⬆Ticker.html1Ticker.<NavigationId>.html1 (HTML div structure)
ticker.rendered2ticker →variables ⬆Ticker.html2Ticker.<NavigationId>.html2 (HTML table structure)
ticker.rendered3ticker →variables ⬆Ticker.html3Ticker.<NavigationId>.html3 (HTML table structure, fixed image size 180)
ticker.listticker →variables ⬆ticker.listticker.<NavigationId>.list.<Position>.<ItemProperty>
article.htmlInfoarticle →variables ⬆Article.HtmlArticle.<Number>.Html
article.iconarticle →variables ⬆Article.IconArticle.<Number>.Icon
article.imagearticle →variables ⬆Article.ImageArticle.<Number>.Image
article.keywordsarticle →variables ⬆Article.KeywordsArticle.<Number>.Keywords
article.shortnamearticle →variables ⬆Article.ShortnameArticle.<Number>.Shortname
article.infotxtarticle →variables ⬆Article.Textarticle.<Number>.Text
article.urlarticle →variables ⬆Article.UrlArticle.<Number>.Url
article.wiki2htmlarticle →variables ⬆Article.Wiki2HTMLArticle.<Number>.Wiki2HTML
order.complainlinkorder →variables ⬆Order.ComplainOrder.<no>.Complain, link to complain about this order
order.complainurlorder →variables ⬆Order.ComplainURLOrder.<no>.ComplainURL (URL to complain about this order)
order.linktextorder →variables ⬆Order.LinkOrder.<no>.Link (link to the order, text version)
order.linkorder →variables ⬆Order.ViewOrder.<no>.View, link to view the order in the shop
gs.codegs →variables ⬆Voucher.CodeVoucher.<Nummer>.Code
gs.untilgs →variables ⬆Voucher.ValidUntilVoucher.<Nummer>.ValidUntil
link.complainlinklink →variables ⬆Link.ComplaintLink to the complaint page (no login)
link.complainurllink →variables ⬆Link.ComplaintURLURL to the complaint page (no login)
link.confirmlinklink →variables ⬆Link.ConsentConfirmation of email sending + GDPR
link.confirmurllink →variables ⬆Link.ConsentURLConfirmation of email sending + GDPR, URL
link.impressumlinklink →variables ⬆Link.ImprintLink to the Imprint
link.impressumurllink →variables ⬆Link.ImprintURLURL to the Imprint
link.loginlinklink →variables ⬆Link.LogonDirect Logon
link.shoplinklink →variables ⬆Link.ShopLink to the Online Shop
link.shopurllink →variables ⬆Link.ShopURLURL to Shop
link.sitelinklink →variables ⬆Link.SiteLink to HomeSite
link.siteurllink →variables ⬆Link.SiteURLURL to HomeSite
link.agblinklink →variables ⬆Link.TermsLink to the Terms
link.agburllink →variables ⬆Link.TermsURLURL to the Terms
link.trustpilotlinklink →variables ⬆Link.TrustpilotLink to Trustpilot survey
link.trustpiloturllink →variables ⬆Link.TrustpilotURLURL to Trustpilot survey
ag.confirmlinkag →variables ⬆AGLink.ConsentConfirmation of email sending + GDPR
ag.confirmurlag →variables ⬆AGLink.ConsentURLConfirmation of email sending + GDPR, URL
ag.impressumlinkag →variables ⬆AGLink.ImprintLink to the Imprint
ag.impressumurlag →variables ⬆AGLink.ImprintURLURL to the Imprint
ag.homeag →variables ⬆AGLink.ShopAGLink.<no>.Shop
ag.shoplinkag →variables ⬆AGLink.ShopLinkLink to the Online Shop
ag.shopurlag →variables ⬆AGLink.ShopURLURL to Shop
ag.sitelinkag →variables ⬆AGLink.SiteLink to your website
ag.siteurlag →variables ⬆AGLink.SiteURLURL to your website
ag.agblinkag →variables ⬆AGLink.TermsLink to the Terms and Conditions
ag.agburlag →variables ⬆AGLink.TermsURLURL to the Terms and Conditions
ag.trustpilotlinkag →variables ⬆AGLink.TrustpilotLink to Trustpilot survey
ag.trustpiloturlag →variables ⬆AGLink.TrustpilotURLURL to Trustpilot survey
util.longDateutil →variables ⬆Date.LongLong form of the date (day of personalization), e.g. August 26, 2017
util.shortDateutil →variables ⬆Date.ShortShort form of the date (day of personalization), e.g. 8/26/17
util.nowutil →variables ⬆NowCurrent timestamp (e.g. 8/26/17 1:17 PM)
util.weekutil →variables ⬆WeekWeek number (day of personalization), e.g. 22
reldate.longDatereldate →variables ⬆RelDate.LongRelDate.<Days>.Long
reldate.shortDatereldate →variables ⬆RelDate.ShortRelDate.<Days>.Short
qr.codeqr →variables ⬆QR.CodeQR.<Amount>.Code (QR code bank transfer, amount in Euro)
tb.maildeliveredtb →variables ⬆TB.Delivered
mail.campaignidmail →variables ⬆Mail.CampaignCampaign ID, if given.
mail.serierefmail →variables ⬆Mail.SeriesSeries ID, if given.