Order Confirmation Email Markers
Order confirmation email template support markers. A marker is placeholder text wrapped in dollar signs, such as $sitename$. When the email is sent, each marker is replaced with the real details for that order, so $sitename$ becomes the name of the venue.
Markers can be used in the header, order details (basket) and footer sections of the email. A smaller set can also be used in the subject line, listed under Subject line markers.
-
Some markers only appear when they apply. Markers such as $externaltransactionid$, $pickuptime$, $roomphrase$ and $roomnumber$ are only filled in when the order has that information. If you use one of these in a template and the order has no value for it, the placeholder text is left in the email. Only use these markers in templates meant for those order types.
-
If a marker is misspelled or uses different wording, it will not be recognised and the raw text will appear in the email.
Order Confirmation Email Markers Topics
Non-Order Mode Specific
These markers are filled in for every order, regardless of the order mode.
Venue and Sales Area details
| Marker | What it shows | Supported order modes |
|---|---|---|
| $sitename$ | The name of the venue the order was placed at. | All order modes |
| $salesareaname$ | The name of the sales area within the venue, such as "Beer Garden" or "Restaurant". | All order modes |
| $siteaddress1$ | The first line of the venue's address. | All order modes |
| $siteaddress2$ | The second line of the venue's address. | All order modes |
| $sitetown$ | The town or city the venue is in. | All order modes |
| $sitepostcode$ | The venue's postcode. | All order modes |
| $sitephone$ | The venue's contact phone number. | All order modes |
| $salesareaphone$ | The contact phone number for the sales area, if one is set. | All order modes |
Order and payment references
| Marker | What it shows | Supported order modes |
|---|---|---|
| $accountid$ | iOrder Platform's order reference. | All order modes |
| $accountnumber$ | Aztec's Account Number. | All order modes |
| $aztecaccountid$ | Aztec's unique account identifier. | All order modes |
| $braintreetransactionid$ | The payment reference for card payments taken through Braintree. | All order modes |
| $externaltransactionid$ | The payment reference for orders paid via an external payment provider. Only appears when the order was paid this way. | All order modes |
| $paymenttype$ | The name of the payment method used by the guest. Populated for Braintree orders or subject to the 3rd party integrator supporting this value. | All order modes |
Guest information
| Marker | What it shows | Supported order modes |
|---|---|---|
| $useremailaddress$ | The email address the guest used to place the order. | All order modes |
Dates and times
| Marker | What it shows | Supported order modes |
|---|---|---|
| $orderdate$ | The date the order was placed. | All order modes |
| $ordertime$ | The time the order was placed. | All order modes |
Totals and tax
| Marker | What it shows | Supported order modes |
|---|---|---|
| $baskettotal$ | The total amount for the order. | All order modes |
| $baskettotalexcludingservicecharges$ | The order total with any service charges removed. | All order modes |
| $tip$ | The tip amount added to the order. | All order modes |
| $grandtotal$ | The final amount charged, being the order total plus any tip. | All order modes |
| $vat$ | The VAT rate applied, as a percentage. | All order modes |
| $vatvalue$ | The amount of VAT included in the total. | All order modes |
| $vatnumber$ | The venue's VAT registration number. | All order modes |
| $inclusivetaxbreakdown$ | A breakdown of taxes already included in the item prices, shown as rows in the order summary. | All order modes |
| $exclusivetaxbreakdown$ | A breakdown of any taxes and service charges added on top of the item prices, shown as rows in the order summary. | All order modes |
Order contents and branding
| Marker | What it shows | Supported order modes |
|---|---|---|
| $products$ | The full list of items ordered, including options, choices, promotions, vouchers and gift card redemptions. | All order modes |
| $headerimage$ | The header image configured for your emails. | All order modes |
| $footerimage$ | The footer image configured for your emails. | All order modes |
Charge to Room
Charge to Room is a payment method rather than an order mode, so these markers can appear for any order mode. They only appear when the order was charged to a room.
| Marker | What it shows | Supported order modes |
|---|---|---|
| $roomphrase$ | The wording configured for Charge to Room orders, such as "Room" or "Cabin". | All order modes |
| $roomnumber$ | The room number the order is charged to. | All order modes |
Order Mode Specific
These markers only work with, or only appear for, particular order modes. Only use them in templates meant for those order types.
Order & Pay and Pay My Bill
| Marker | What it shows | Supported order modes |
|---|---|---|
| $tablenumber$ | The table number the order was placed against. | Order & Pay, Pay My Bill |
Click & Collect and Delivery to Location
Pickup time
| Marker | What it shows | Supported order modes |
|---|---|---|
| $pickuptime$ | The collection or serving time for a Click & Collect or Delivery to Location order. Only appears when a pickup time has been chosen. | Click & Collect and Delivery to Location |
Additional order information
If the order mode is configured to collect additonal information for Click & Collect and Delivery to Location orders, such as a name, a location identifier, or a telephone number, those details can be shown using the markers below. Each field has a label (the question) and a value (what the guest entered). If a guest did not provide a value, it shows as "N/A".
| Marker | What it shows | Supported order modes |
|---|---|---|
| $delayedorderfield1label$ | The label for the first additional field. | Click & Collect and Delivery to Location |
| $delayedorderfield1value$ | The guest's response for the first additional field. | Click & Collect and Delivery to Location |
| $delayedorderfield2label$ | The label for the second additional field. | Click & Collect and Delivery to Location |
| $delayedorderfield2value$ | The guest's response for the second additional field. | Click & Collect and Delivery to Location |
Subject line markers
The subject line supports a smaller set of markers. Only the following will be replaced in the subject; other markers will not work there.
| Marker | What it shows | Supported order modes |
|---|---|---|
| $estatename$ | The estate name as defined in iOrder Platform. | All order modes |
| $accountnumber$ | Aztec's account number. | All order modes |
| $delayedorderfield1label$ | The label for the first additional field. | Click & Collect and Delivery to Location |
| $delayedorderfield1value$ | The guest's response for the first additional field. | Click & Collect and Delivery to Location |
| $delayedorderfield2label$ | The label for the second additional field. | Click & Collect and Delivery to Location |
| $delayedorderfield2value$ | The guest's response for the second additional field. | Click & Collect and Delivery to Location |