HTML variables for email templates

When creating custom email templates, Optimizely Configured Commerce provides a variety of HTML variables. All template variables are prefaced with Model. Additionally, all fields that end with "Display", are strings formatted to the current currency/numeric format.

Email templates use the DotLiquid syntax and should use the following format:

• [[Model.FirstName]]

Template variables

Admin_AccountActivation

• DisplayName
• ActivationUrl
• ActivationUrlExpirationInDays
• ContentBaseUrl

📘

Note

Change your account activation email templates from "Hello [[Model.UserName]]" to "Hello [[Model.DisplayName]]" if you want to continue including the user's First and Last Name. The user's actual UserName will appear if the First and Last Name fields are empty.

Admin_ResetPassword

• ContentBaseUrl
• UserFirstName
• UserName
• PasswordResetUrl
• PasswordResetUrlExpirationInDays

ContactUsTemplate

• FirstName
• LastName
• Email
• Topic
• Message

ForgotPassword

• Email
• NewPassword
• WebsiteUrl

OrderApproval

• Subject
• ErpOrderNumber
• OrderDate
• CustomerPO
• Carrier
• Service
• Status
• BTDisplayName
• BTCompany
• BTAddress1
• BTAddress2
• BTCity
• BTState
• BTPostalCode
• BTCountry
• BTPhone1
• BTEmail
• STDisplayName
• STCompany
• STAddress1
• STAddress2
• STCity
• STState
• STPostalCode
• STCountry
• STPhone1
• STEmail
• OrderSubTotalDisplay
• FullShippingChargeDisplay
• TotalTaxDisplay
• OrderGrandTotalDisplay
• Notes

OrderConfirmation

• OrderNumber
• StatusDisplay
• CustomerPO
• OrderDate - string
• OrderLines - list of objects of this format
  • ProductName
  • Description
  • QtyOrdered
  • ActualPrice
  • UnitNetPriceDisplay
  • ExtendedUnitNetPriceDisplay
• BTDisplayName - company or person name
• BTAddress1
• BTAddress2
• BTAddress3
• BTCity
• BTState
• BTZip
• BTPostalCode
• BTCountry
• BTCompany
• BTEmail
• BTPhone1
• STDisplayName
• STAddress1
• STAddress2
• STAddress3
• STCity
• STState
• STZip
• STPostalCode
• STCountry
• STCompany
• STEmail
• STPhone1
• ShipMethod
• RequestedDeliveryDate
• OrderSubTotal
• OrderSubTotalDisplay
• OrderSubTotalWithOutProductDiscounts
• OrderSubTotalWithOutProductDiscountsDisplay
• PromotionProductDiscountTotal
• PromotionProductDiscountTotalDisplay
• PromotionOrderDiscountTotal
• PromotionOrderDiscountTotalDisplay
• FullShippingCharge
• FullShippingChargeDisplay
• Handling
• HandlingDisplay
• PromotionShippingDiscountTotal
• PromotionShippingDiscountTotalDisplay
• CustomerOrderTaxes
• LocalTax
• LocalTaxDisplay
• StateTax
• StateTaxDisplay
• TotalTax
• TotalTaxDisplay
• CreditCardWillBeCharged - boolean
• OrderGrandTotal
• OrderGrandTotalDisplay
• GiftCardTotal
• GiftCardTotalDisplay
• OrderTotalDue
• OrderTotalDueDisplay
• Notes

PunchOut_FailedOrderRequest

• RequestDate
• OrderId
• BillToName
• Message - hardcoded message describing the error

RequestAQuote

• OrderNumber
• OrderDate - short date string
• PONumber
• BTDisplayName
• BTEmail
• Notes
• Address - full addres with newline characters
• OrderLines - list of objects
  • Name
  • ShortDescription
  • QtyOrdered
  • RMAQtyRequested
  • RMAReturnReason

RequestRMA

• obsolete

RfqQuote

• EmailHeaderFields - Dictionary<string,string> with these keys:
• Sales Rep:
• User:
• Customer:
• Quote Number:
• Date Submitted:
• Customer Notes:
• OrderStatus
• QuoteUrl
• Headline
• OrderLines - list of objects of this format
• ProductName
• Description
• Qty
• Uom
• Notes
• ImagePath
• RequiresQuote
• ActualPrice
• ActualPriceDisplay
• ExtendedActualPrice
• ExtendedActualPriceDisplay
• ItemNumber
• ProductUrl
• ActualBreakPrices - List<ProductPrice>
• MaxQty

ShareInvoice

• EmailTo
• EmailFrom
• Subject
• Message
• WebsiteUrl
• File
• FileUrl
• FileName

ShareOrder

• EmailTo
• EmailFrom
• Subject
• Message
• WebsiteUrl
• File
• FileUrl
• FileName

ShipmentConfirmation

• TrackingItems - list of tracking html anchor tags
• PONumber
• OrderedByName
• OrderedByEmail
• OrderedByPhone
• OrderedByFax
• ShipmentDate - short date string
• OrderTerms
• OrderNumber
• OrderDate
• BillingName
• BillingAddress
• ShippingName
• ShippingAddress
• LocalTax - cost, string
• StateTax - cost, string
• TotalTax - cost, string
• Handling - cost, string
• Shipping - cost, string
• ShippingAndHandling
• MerchandiseTotal - subtotal - string
• OrderTotal - string
• GrandTotal - string
• ShipCode
• ShipmentPackages - list of ShipmentPackage objects
• PackageCount
• ShipMethod

StatusReport

• RealTimeJobs - List<IntegrationJob> - realtime only
• BatchJobs - List<IntegrationJob> - not realtime only
• ClientName
• Environment
• LookBackDate
• PercentSuccess
• AbandonedCarts
• OrdersProcessed

Storefront_AccountActivation

• DisplayName
• ActivationUrl
• ActivationUrlExpirationInDays
• ContentBaseUrl

📘

Note

Change your account activation email templates from "Hello[[Model.UserName]]" to "Hello [[Model.DisplayName]]" if you want to continue including the user's First and Last Name. he user's actual UserName will appear if the First and Last Name fields are empty.

Storefront_ResetPassword

• ContentBaseUrl
• UserFirstName
• UserName
• PasswordResetUrl
• PasswordResetUrlExpirationInDays

TellAFriend

• FriendsName
• FriendsEmail
• UsersName - your name
• UsersEmail
• UsersMessage
• ProductShortDescription
• AltText
• ProductUrl
• WebsiteUrl
• ProductImage - product image url