Individual emails will also have additional variables. For example, the receipt template will have the $order variable. Please consult existing examples for specific variables.
...
Template Name | Abbreviation |
---|
auto_order_cancel | CAN |
auto_order_confirmation | CON |
auto_order_preshipment | PRE |
auto_order_update_billing_decline | BD |
auto_order_update_billing | B |
customer_feedback | CF |
digital_delivery | DD |
gift_receipt | GR |
quote | Q |
quote_request | QR |
receipt | R |
refund | RF |
shipment_notification | SN |
Variable Name | Variable Type | CAN | CON | PRE | BD | B | CF | DD | GR | Q | QR | R | RF | SN | Comments |
---|
$autoOrderCode | string | X | X |
| | | | | | | | | |
|
|
|
|
|
|
|
|
|
|
| unique id for auto order |
$autoOrderCancelLink | string |
| | | | | | | | | | |
|
|
|
|
|
|
|
|
|
|
| link for customer to cancel order |
$beoe | boolean |
| | | | | | | | |
| X | true if order was entered manually using the backend order entry tool |
$chargeAppearsOnStatementAs | string |
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
|
$customerName | string | X | X | X | X | X | X | X | X | X | X | X | X | X |
|
|
$customerFirstName | string | X | X | X | X | X | X | X | X | X | X | X | X | X |
|
|
$customerServiceEmail | string | X | X | X | X | X | X | X | X | X | X | X | X |
|
|
|
Variable Name | Variable Type | CAN | CON | PRE | BD | B | CF | DD | GR | Q | QR | R | RF | SN | Comments |
---|
$customerShipToName | string | X | X |
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
|
|
|
|
|
| expiration of digital content |
$expirationRaw | Date |
| | | | | | | | | | | |
|
|
|
|
|
| expiration of digital content Useful for formatting the date into a different timezone. See $formatHelper.formatDate. |
$giftMessage | string |
| | | | | | | | | | | | |
| X | X | X | X | X | order text formatted with div tags (high customization) |
htmlTableOrder | string | X | X |
| |
| X | X | X | X | X | order text formatted with tables (robust) |
htmlEmailOrder | string | X | X |
|
| X | X | X | X | X | order text formatted for emails |
$i18n | I18n | X | X | X | X | X | X | X | X | X | X | X | X | X |
| | | | | | | | | | | | | | | | | | | | | |
|
|
|
|
|
| download link for digital content |
$merchantComments | string |
| | | | | | | | | | | |
|
$merchantName | string | X | X | X | X | X | X | X | X | X | X | X | X | X |
| | | | | | | | | | |
|
|
|
|
|
|
| message from merchant to customer |
$messageDate | Date |
| | | | | | | | | | |
|
|
|
|
|
|
| date of the customer feedback message |
Variable Name | Variable Type | CAN | CON | PRE | BD | B | CF | DD | GR | Q | QR | R | RF | SN | Comments |
---|
$order | Order | X | X |
| | | | | | | | | | |
|
| X | X | X | X | X | order summary as plain text |
$orderSummaryHtml | string | X | X |
| |
|
| X | X | X | X | X | order summary with html markup |
$originalDate | Date |
| | | | | | | | | | | | | | | | | | | |
|
|
|
$phone | string | X | X | X | X | X | X | X | X | X | X | X | X | X |
|
|
$preshipmentCancelLink | string |
| | | | | | | | | |
|
|
|
|
|
|
|
|
|
| customer may use this link to cancel auto order |
$preshipmentItemDescription | string |
| | | | | | | | | | | | | | | | | | | | | | string |
|
| X |
|
|
|
|
|
|
|
|
|
|
|
$preshipmentNextDate | Date |
| | | | | | | | | | | |
|
|
|
|
|
|
|
|
|
| date of next shipment |
$preshipmentNextItemQuantity | number |
| | | | | | | | | | |
|
|
|
|
|
|
|
|
|
|
|
$preshipmentNextItemId | string |
| | | | | | | | | | | | |
|
|
|
|
|
|
|
|
|
|
|
$preshipmentNextItemDescription | string |
| | | | | | | | | | | |
|
|
|
|
|
|
|
|
|
|
|
Variable Name | Variable Type | CAN | CON | PRE | BD | B | CF | DD | GR | Q | QR | R | RF | SN | Comments |
---|
$purchaseOrderNumber | string | X | X |
| | | | | | | | | | | | | | | | | | |
|
|
| hyperlink to the full quote online |
$refundTotal | string |
| | | | | | | | | | | |
|
|
$returnPolicy | string | X | X | X | X | X | X | X | X | X | X | X | X | X |
| | | | | | | | | | | | | | | | | | | | | | | | | | | | |
|
$shippingTrackingNumbersNoURL | string[ ] |
| | | | | | | | | | |
|
|
|
|
|
|
|
|
|
|
|
| X | notice Numbers is plural. this is all tracking numbers |
$shippingTrackingNumbers | string[ ] |
| | | | | | | | | | |
|
|
|
|
|
|
|
|
|
|
|
| X | notice Numbers is plural. this is all tracking numbers |
$shippingTrackingNumberNoURL | string |
| | | | | | | | | | | | |
|
$shippingTrackingNumberNoURL2 | string |
| | | | | | | | | | | |
|
$shippingTrackingNumberNoURL3 | string |
| | | | | | | | | | | |
|
$shippingTrackingNumberNoURL4 | string |
| | | | | | | | | | | | |
|
$shippingTrackingNumberNoURL5 | string |
| | | | | | | | | | | |
|
$shippingTrackingNumber | string |
| | | | | | | | | | | |
|
$shippingTrackingNumber2 | string |
| | | | | | | | | | | | |
|
$shippingTrackingNumber3 | string |
| | | | | | | | | | | |
|
$shippingTrackingNumber4 | string |
| | | | | | | | | | | |
|
$shippingTrackingNumber5 | string |
| | | | | | | | | | | | |
|
Variable Name | Variable Type | CAN | CON | PRE | BD | B | CF | DD | GR | Q | QR | R | RF | SN | Comments |
---|
$site | Site | X | X | X | X | X | X | X | X | X | X | X | X | X |
|
| X | X | X | X | X | X | X | X | X | X | order as pre-formatted text (see html*Order fields) |
$updateLink | string | X |
| | | | | | | | |
|
|
|
|
|
|
|
| link customer may use to update their auto order information |