Email Template Variables

Email Template Variables

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

 

X

 

 

 

 

 

 

 

 

 

 

 

link for customer to cancel order

$beoe

boolean

 

 

 

 

 

 

 

X

 

 

X

 

X

true if order was entered manually using the backend order entry tool

$chargeAppearsOnStatementAs

string

 

 

 

X

X

 

 

X

 

 

X

 

 

 

$creationDate

string

X

X

 

 

 

 

X

 

 

 

 

X

X

 

$creationDateRaw

Date

X

X

 

 

 

 

X

 

 

 

 

X

X

Useful for formatting the date into a different timezone. See $formatHelper.formatDate.

$customField1

string

 

 

 

X

X

 

 

X

X

X

X

 

X

 

$customField2

string

 

 

 

X

X

 

 

X

X

X

X

 

X

 

$customField3

string

 

 

 

X

X

 

 

X

X

X

X

 

X

 

$customField4

string

 

 

 

X

X

 

 

X

X

X

X

 

X

 

$customField5

string

 

 

 

X

X

 

 

X

X

X

X

 

X

 

$customField6

string

 

 

 

X

X

 

 

X

X

X

X

 

X

 

$customField7

string

 

 

 

X

X

 

 

X

X

X

X

 

X

 

$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

 

 

 

 

 

 

 

 

 

 

X

 

$deliveryDate

string

 

 

 

 

 

 

 

X

 

 

X

 

 

 

$deliveryDateRaw

Date

 

 

 

 

 

 

 

X

 

 

X

 

 

 Useful for formatting the date into a different timezone. See $formatHelper.formatDate.

$email

string