HTML variables for email templates

  • Updated

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

Abandoned Cart

    • ProductNumber
    • ProductName
    • QtyOrdered
    • QuoteRequired
    • UnitNetPrice
    • UnitNetPriceDisplay
    • Uom
    • ImagePath
  • OrderLines - list of objects of this format
  • UnsubscribeUrl
  • UnsubscribeLabel
  • CartUrl
  • NotIncludedProductsCount
  • WebsiteName
  • UserLastName
  • UserFirstName
  • LogoImagePath

Admin_AccountActivation

  • LogoImagePath
  • ContentBaseUrl
  • ActivationUrlExpirationInDays
  • ActivationUrl
  • Email
  • 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.

Admin_ResetPassword

  • LogoImagePath
  • PasswordResetUrlExpirationInDays
  • PasswordResetUrl
  • UserName
  • UserFirstName
  • ContentBaseUrl

ContactUsTemplate

  • Message
  • Topic
  • Email
  • LastName
  • FirstName

ForgotPassword

  • Obsolete - This has been replaced with a feature that allows users to reset their own passwords. The email templates used in the reset password process are Admin_ResetPassword and Website_ResetPassword email templates in this article, 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
  • LogoImagePath

OrderConfirmation

    • ProductNumber
    • Description
    • QtyOrdered
    • QtyOrderedDisplay
    • UnitNetPrice
    • UnitNetPriceDisplay
    • ExtendedUnitNetPrice
    • ExtendedUnitNetPriceDisplay
    • BrandName
  • OrderLines - list of objects of this format
  • GiftCardTotalDisplay
  • GiftCardTotal
  • OrderGrandTotalDisplay
  • OrderGrandTotal
  • OrderSubTotalDisplay
  • OrderSubTotal
    • TaxCode
    • TaxDescription
    • TaxRate
    • TaxAmount
    • TaxAmountDisplay
    • SortOrder
  • CustomerOrderTaxes - list of objects of this format
  • 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

PunchOut_FailedOrderRequest

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

RequestAQuote

  • obsolete

RequestRMA

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

RfqQuote

    • 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
  • OrderLines - list of objects of this format
  • ProductName
  • QuoteUrl
  • ShowPricing
  • Headline
  • OrderStatus
    • Sales Rep:
    • User:
    • Customer:
    • Quote Number:
    • Date Submitted:
    • Customer Notes:
  • EmailHeaderFields - Dictionary<string,string> with these keys:

SendAListCopy

  • ListUrl
  • DisplayName
  • Message
  • ListName

ShareInvoice

  • FullName
  • WebsiteUrl
  • Message
  • Subject
  • EmailFrom
  • EmailTo

ShareListWithBillTo

  • ListUrl
  • DisplayName
  • Message
  • ListName

ShareOrder

  • FullName
  • WebsiteUrl
  • Message
  • Subject
  • EmailFrom
  • EmailTo

ShipmentConfirmation

  • PackageCount
  • ShipmentPackagesCount
    • ErpNumber
    • Description
    • QtyOrdered
    • QtyShipped
    • UnitOfMeasure
  • ShipmentPackages -list of ShipmentPackage objects ShipmentPackageLines - list of Dictionary<string, object>, where the keys are:
  • LogoImagePath
  • 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

  • LogoImagePath
  • ContentBaseUrl
  • ActivationUrlExpirationInDays
  • ActivationUrl
  • Email
  • 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

  • LogoImagePath
  • PasswordResetUrlExpirationInDays
  • PasswordResetUrl
  • UserName
  • UserFirstName
  • ContentBaseUrl

TellAFriend

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