Page Comparison

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`	true if order was entered manually using the backend order entry tool
`$chargeAppearsOnStatementAs`	`string`

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


`$deliveryDateRaw`	`Date`

X

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

X

X X X X


`$expiration`	string

X

							expiration of digital content
`$expirationRaw`	`Date`

X

expiration of digital content

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

$giftMessage string

X


`htmlDivOrder`	`string`	`X`	`X`

X X X X

	`X`	`X`	`X`	`X`	`X`	order text formatted with div tags (high customization)
`htmlTableOrder`	`string`	`X`	`X`

X X X X

	`X`	`X`	`X`	`X`	`X`	order text formatted with tables (robust)
`htmlEmailOrder`	`string`	`X`	`X`

X X 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


`$instructions`	`string`

X


`$link`	`string`

X

						download link for digital content
`$merchantComments`	`string`

X

$merchantName string X X X X X X X X X X X X X


`$message`	`string`

X

							message from merchant to customer
`$messageDate`	`Date`

X

Variable Name	Variable Type	CAN	CON	PRE	BD	B	CF	DD	GR	Q	QR	R	RF	SN	Comments
							date of the customer feedback message
`$order`	`Order`	`X`	`X`

X X X X

X X X

X


`$orderHelper`	`OrderHelper SFO`

X


`$orderId`	`string`	`X`	`X`

X X X X

X X X X X


`$orderSummary`	`string`	`X`	`X`

X X X

			`X`	`X`	`X`	`X`	`X`	order summary as plain text
`$orderSummaryHtml`	`string`	`X`	`X`

X X X

		`X`	`X`	`X`	`X`	`X`	order summary with html markup
`$originalDate`	`Date`

X X X


`$paymentMethod`	`string`

X

$phone string X X X X X X X X X X X X X


`$preshipmentCancelLink`	`string`

X

										customer may use this link to cancel auto order
`$preshipmentItemDescription`	`string`

X


`$preshipmentItemId`	`string`

X


`$preshipmentItemCost`

string X

$preshipmentNextDate Date

X

										date of next shipment
`$preshipmentNextItemQuantity`	`number`

X


`$preshipmentNextItemId`	`string`

X


`$preshipmentNextItemDescription`	`string`

X

Variable Name	Variable Type	CAN	CON	PRE	BD	B	CF	DD	GR	Q	QR	R	RF	SN	Comments

`$purchaseOrderNumber`	`string`	`X`	`X`

X X


`$quoteReviewLink`	`string`

X X

			hyperlink to the full quote online
`$refundTotal`	`string`

X

$returnPolicy string X X X X X X X X X X X X X


`$shipDate`	`string`

X


`$shipDateRaw`	`Date`

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

$shippingMethod string

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

X


`$shippingTrackingNumberNoURL2`	`string`

X


`$shippingTrackingNumberNoURL3`	`string`

X


`$shippingTrackingNumberNoURL4`	`string`

X


`$shippingTrackingNumberNoURL5`	`string`

X


`$shippingTrackingNumber`	`string`

X


`$shippingTrackingNumber2`	`string`

X


`$shippingTrackingNumber3`	`string`

X


`$shippingTrackingNumber4`	`string`

X


`$shippingTrackingNumber5`	`string`

X

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`


`$textOrder`	`string`	`X`	`X`

X X X X X X X X X X order as pre-formatted text (see html*Order fields)

$updateLink string X

X X X

link customer may use to update their auto order information

Versions Compared

Old Version 15

New Version Current

Key