HTML variables for email templates
15 min
Configured Commerce provides a variety of HTML variables for creating custom email templates. 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
Common
- CurrentYear
- WebsiteUrl
- WebsiteName
- LogoImagePath
Abandoned Cart
- OrderLines – list of objects of this format
- ProductNumber
- ProductName
- QtyOrdered
- QuoteRequired
- UnitNetPrice
- UnitNetPriceDisplay
- Uom
- ImagePath
- UnsubscribeUrl
- UnsubscribeLabel
- CartUrl
- NotIncludedProductsCount
- UserLastName
- UserFirstName
Admin_AccountActivation
- ContentBaseUrl
- ActivationUrlExpirationInDays
- ActivationUrl
- LastName
- FirstName
- DisplayName
- UserName
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
- PasswordResetUrlExpirationInDays
- PasswordResetUrl
- UserName
- UserFirstName
- ContentBaseUrl
ContactUsTemplate
- Message
- Topic
- LastName
- FirstName
ForgotPassword (obsolete)
This is replaced with a feature that lets users reset their own passwords. The email templates used in the reset password process are Admin_ResetPassword and Website_ResetPassword email templates for the Admin Console and storefront, respectively.
InviteToList
- ListUrl – the list invitation url; specific to the recipient
- DisplayName
- Message
- ListName
ListEmailReminder
- ListUrl
- Message
- WebsiteName
- ListName
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
- OrderLines – list of objects of this format
- ProductNumber
- Description
- QtyOrdered
- QtyOrderedDisplay
- UnitNetPrice
- UnitNetPriceDisplay
- ExtendedUnitNetPrice
- ExtendedUnitNetPriceDisplay
- BrandName
- GiftCardTotalDisplay
- GiftCardTotal
- OrderGrandTotalDisplay
- OrderGrandTotal
- OrderSubTotalDisplay
- OrderSubTotal
- CustomerOrderTaxes – list of objects of this format
- TaxCode
- TaxDescription
- TaxRate
- TaxAmount
- TaxAmountDisplay
- SortOrder
- TotalTaxDisplay
- TotalTax
- StateTaxDisplay
- StateTax
- LocalTaxDisplay
- LocalTax
- HandlingDisplay
- Handling
- FullShippingChargeDisplay
- FullShippingCharge
- PromotionShippingDiscountTotalDisplay
- PromotionShippingDiscountTotal
- PromotionOrderDiscountTotalDisplay
- PromotionOrderDiscountTotal
- PromotionProductDiscountTotalDisplay
- PromotionProductDiscountTotal
- RequestedPickupDate
- RequestedDeliveryDate
- Notes
- ShipMethod
- STPhone1
- STEmail
- STCompany
- STCountry
- STPostalCode
- STZip
- STState
- STCity
- STAddress2
- STAddress1
- STDisplayName
- BTPhone1
- BTEmail
- BTCompany
- BTCountry
- BTPostalCode
- BTZip
- BTState
- BTCity
- BTAddress2
- BTAddress1
- BTDisplayName
- EnableBrands
- IsAnyProductWithBrand
- FulfillmentMethod
- CheckingStatusUrl
- CreditCardWillBeCharged
- CustomerPO
- OrderDate
- ErpOrderNumber
- OrderNumber
- CCState
- CCCountry
- CCPostalCode
- CCCity
- CCAddress1
- IsCreditCard
- UserFirstName
- UserLastName
- UserName
PunchOut_FailedOrderRequest
- Message – hardcoded message describing the error
- BillToName
- OrderId
- RequestDate
RequestAQuote
- obsolete
RequestRMA
- OrderLines – list of objects
- Name
- ShortDescription
- QtyOrdered
- RMAQtyRequested
- RMAReturnReason
- Address – full address with newline characters
- BTCountry
- BTPostalCode
- BTState
- BTCity
- BTAddress2
- BTAddress1
- BTEmail
- BTDisplayName
- Notes
- PONumber
- OrderDate – short date string
- OrderNumber
RfqQuote
- OrderLines – list of objects of this format
- Description
- Qty
- Uom
- Notes
- ImagePath
- RequiresQuote
- UnitNetPrice
- UnitNetPriceDisplay
- ExtendedUnitNetPrice
- ExtendedUnitNetPriceDisplay
- ItemNumber
- ProductUrl
- UnitRegularBreakPrices - list of Dictionary<string, object>, where the keys are the properties found in BreakPriceDto
- MaxQty
- ProductName
- QuoteUrl
- ShowPricing
- Headline
- OrderStatus
- Sales Rep:
- User:
- Customer:
- Quote Number:
- Date Submitted:
- Customer Notes:
- EmailHeaderFields – Dictionary<string,string> with these keys:
- Sales Rep:
- User:
- Customer:
- Quote Number:
- Date Submitted:
- Customer Notes:
SendAListCopy
- ListUrl
- DisplayName
- Message
- ListName
ShareInvoice
- FullName
- Message
- Subject
- EmailFrom
- EmailTo
ShareListWithBillTo
- ListUrl
- DisplayName
- Message
- ListName
ShareOrder
- FullName
- Message
- Subject
- EmailFrom
- EmailTo
ShipmentConfirmation
- PackageCount
- ShipmentPackagesCount
- ShipmentPackages -list of ShipmentPackage objects ShipmentPackageLines - list of Dictionary<string, object>, where the keys are:
- ErpNumber
- Description
- QtyOrdered
- QtyShipped
- UnitOfMeasure
- ShipCode
- GrandTotal - string
- OrderTotal - string
- MerchandiseTotal - formatted currency string
- ShippingAndHandling
- Shipping - formatted currency string
- Handling - formatted currency string
- TotalTax - formatted currency string
- StateTax - formatted currency string
- LocalTax - formatted currency string
- ShippingAddress
- ShippingName
- BillingAddress
- BillingName
- OrderDate
- OrderNumber
- OrderNotes
- OrderTerms
- ShipmentDate - short date string
- OrderLink
- OrderedByFax
- OrderedByPhone
- OrderedByEmail
- OrderedByName
- PONumber
- TrackingItems – list of tracking html anchor tags
StatusReport
- OrdersProcessed
- AbandonedCarts
- Statuses – list of IntegrationJobStatus (not including Queued)
- PercentSuccess
- LookBackDate
- Environment
- ClientName
- BatchJobsGroupByStatus – grouped collection of IntegrationJob; not real-time only
- RealTimeJobsGroupByStatus – grouped collection of IntegrationJob; real-time only
- BatchJobsGroupByName – grouped collection of IntegrationJob; not real-time only
- RealTimeJobsGroupByName – grouped collection of IntegrationJob; real-time only
- RealTimeJobsAny – boolean
- BatchJobsAny – boolean
Website_AccountActivation
- ContentBaseUrl
- ActivationUrlExpirationInDays
- ActivationUrl
- LastName
- FirstName
- DisplayName
- UserName
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.
Website_ResetPassword
- PasswordResetUrlExpirationInDays
- PasswordResetUrl
- UserName
- UserFirstName
- ContentBaseUrl
TellAFriend
- ProductImage – product image url
- WebsiteName
- ProductUrl
- AltText
- ProductShortDescription
- UsersMessage
- UsersEmail – your email
- UsersName – your name
- FriendsEmail
- FriendsName