Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 NameAbbreviation
auto_order_cancelCAN
auto_order_confirmationCON
auto_order_preshipmentPRE
auto_order_update_billing_declineBD
auto_order_update_billingB
customer_feedbackCF
digital_deliveryDD
gift_receiptGR
quoteQ
quote_requestQR
receiptR
refundRF
shipment_notificationSN

 

...



Variable Name

Variable Type

CANCONPREBDBCFDDGRQQRRRFSNComments
$autoOrderCodestringXX
     
      











unique id for auto order
$autoOrderCancelLinkstring
 

X
          
 











link for customer to cancel order
$beoeboolean
  
     







X
  


X
 

Xtrue if order was entered manually using the backend order entry tool
$chargeAppearsOnStatementAsstring
  



X
 
X

X

X
 



$creationDate
 
stringX
 
X
 $creationDate




X



X
   
X
$creationDateRawDateXX
    




X
 
   




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



XX
  


XXXX
 

X
 

$customField2string
 
  



XX
  


XXXX
 

X
 

$customField3string
   



XX
 
 


XXXX
 

X
 

$customField4string
  
 



XX
  


XXXX
 

X
 

$customField5string
   



XX
  


XXXX
 

X
 

$customField6string
  
 



XX
  


XXXX
 

X
 

$customField7string
  
 



XX
  


XXXX
 

X
 

$customerNamestringXXXXXXXXXXXXX
 

$customerFirstNamestringXXXXXXXXXXXXX
 

$customerServiceEmailstringXXXXXXXXXXXX
  


Variable Name

Variable Type

CANCONPREBDBCFDDGRQQRRRFSNComments
$customerShipToNamestringXX
 










X
 $deliveryDateDate       X  X   $emailstring     X 

$deliveryDate
        X 
string






X

X


$deliveryDateRawDate






X

X

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




X
XXXX
   



$expiration
Date$giftMessagestring      X       
string
      X      expiration of digital content






X





expiration of digital content
$expirationRawDate





X





expiration of digital content

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

$giftMessagestring





X






htmlDivOrderstringXX
 

XXXX
 

XXXXXorder text formatted with div tags (high customization)
htmlTableOrderstringXX
 

XXXX
 

XXXXXorder text formatted with tables (robust)
htmlEmailOrderstringXX
 

XXXX
 

XXXXXorder text formatted for emails
$i18nI18nXXXXXXXXXXXXX
 

$instructionsstring
    
   







X
  


X
   



$linkstring
      






X
      






download link for digital content
$merchantCommentsstring
    
        












X
 

$merchantNamestringXXXXXXXXXXXXX
 

$messagestring
    
 





X
       







message from merchant to customer
$messageDateDate
     





X
  
     







date of the customer feedback message

Variable Name

Variable Type

CANCONPREBDBCFDDGRQQRRRFSNComments
$orderOrderXX
 

XXXX
 

XXX
 

X
 

$orderHelper
Order Helper   

OrderHelper SFO




XXXXXXXXXX
 

$orderIdstringXX
 

XXXX
 

XXXXX
 

$orderSummarystringXX
 

XXX
  


XXXXXorder summary as plain text
$orderSummaryHtmlstringXX
 

XXX
  


XXXXXorder summary with html markup
$originalDateDate
  


XXX
   
      









$paymentMethodstring
       







X
  


X
   



$phonestringXXXXXXXXXXXXX
 

$preshipmentCancelLinkstring
  


X
          










customer may use this link to cancel auto order
$preshipmentItemDescriptionstring
  


X
           











$preshipmentItemIdstring
 
 


X
 











$preshipmentItemCost
          
string

 X










$preshipmentNextDateDate
 
 


X
          










date of next shipment
$preshipmentNextItemQuantitynumber
 
 


X
 
          











$preshipmentNextItemIdstring
 
 


X
          
 











$preshipmentNextItemDescriptionstring
 
 


X
           











Variable Name

Variable Type

CANCONPREBDBCFDDGRQQRRRFSNComments
$purchaseOrderNumberstringXX
   
      









XX
 

$quoteReviewLinkstring
        








XX
   



hyperlink to the full quote online
$refundTotalstring
      
     











X
  


$returnPolicystringXXXXXXXXXXXXX
 

$shipDate
Date
string
  












X
           X

$shipDateRawDate











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


XXXX
 

XXXX
 

X
 

$shippingTrackingNumbersNoURLstring[ ]
     
       












Xnotice Numbers is plural. this is all tracking numbers
$shippingTrackingNumbersstring[ ]
       
     












Xnotice Numbers is plural. this is all tracking numbers
$shippingTrackingNumberNoURLstring
            












X
 

$shippingTrackingNumberNoURL2string
      
      












X
 

$shippingTrackingNumberNoURL3string
        
    












X
 

$shippingTrackingNumberNoURL4string
            












X
 

$shippingTrackingNumberNoURL5string
            












X
 

$shippingTrackingNumberstring
       
     












X
 

$shippingTrackingNumber2string
            












X
 

$shippingTrackingNumber3string
            












X
 

$shippingTrackingNumber4string
       
     












X
 

$shippingTrackingNumber5string
            












X
 

Variable Name

Variable Type

CANCONPREBDBCFDDGRQQRRRFSNComments
$siteSiteXXXXXXXXXXXXX
 

$textOrderstringXX
 

XXXXXXXXXXorder as pre-formatted text (see html*Order fields)
$updateLinkstringX
 

XXX
        








link customer may use to update their auto order information