E-Mail Template Tokens

Overview

Hotcakes has a very useful e-mail template system that is made available to store owners so that you can ensure your branding is effectively in place when notifications are sent internally and externally via e-mail.  This article helps you to understand what the various tokens are.  

Requirements

The following prerequisites will be necessary to accomplish the goals of this article:

• Have access to your Hotcakes store administration
• Understanding of the e-mail templates feature
• Basic understanding of how token replacement works

Getting Started

There are no tasks required to proceed with this article.

Available E-Mail Template Tokens

Tokens are used in many systems, and Hotcakes is no different when it comes to e-mail messages that are sent to customers, affiliates, and even your staff.  E-mails need to contain relevant information, and tokens allow you to insert placeholders that the system will later replace.  For example, a placeholder might be in place to later inject the customer's name.  

Before we go over the tokens, it's worth noting that there are different types of templates that they might be used in.  Those types are discussed below.

Template Type	Includes
Affiliate	Admin Affiliate Approvement, Affiliate Approved Confirmation, Affiliate Registration Confirmation
Gift Card	Gift Card Notification
Order	Abandoned Cart, Admin Order Receipt, Drop Shipper Notice, Order New Receipt, Order Shipment, VAT Invoice
User	Forgot Password Template, Product Role Assignment
Custom	(Same as Order)

The available tokens you can use are listed in the following grid.  You'll see the tokens listed alongside a specific template type, and/or a specific template where they're used.

Token	In Templates	Description
[[Affiliate.AffiliateName]]	Affiliate	This is the username of the affiliate, as specified when they joined the affiliate program.
[[Affiliate.Approve.Url]]	Affiliate	This is the URL to get to the affiliate profile page as a merchant to approve the affiliate, if necessary.
[[CustomMessage]]	Contact Abandoned Cart Customers	This is a message that you've specified when using the "Contact Abandoned Cart Users" functionality.
[[GiftCard.Amount]] *	Gift Card	The amount that the gift card was purchased for, such as $500.00. This is displayed in the store's currency.
[[GiftCard.CardNumber]] *	Gift Card	This is the unique number assigned to the gift card. An example of this may be GIFT-123A-456B-789C.
[[GiftCard.ExpirationDate]] *	Gift Card	When a gift card is purchased, it comes with an expiration date, displayed here using the localization settings of the web server, such as 01/01/2016.
[[GiftCard.GiftMessage]] *	Gift Card	When purchased, a gift message may have been saved. This will be replaced.
[[GiftCard.RecipientEmail]] *	Gift Card	This is the e-mail address of the person that was specified to receive the gift card.
[[GiftCard.RecipientName]] *	Gift Card	This is the name of the person that was specified to receive the gift card.
[[LineItem.AdjustedPrice]] *	Gift Card, Order	This will reflect the price per item, which is highly relevant when quantities of 2 or more are being purchased.  It is essentially the subtotal amount of the line item divided by the total quantity of that line item.
[[LineItem.BasePrice]] *	Gift Card, Order	Except when the line item is a gift card or a user supplied price item, this will reflect the beginning price of the line item, before discounts.
[[LineItem.Discounts]] *	Gift Card, Order	This will return a line by line representation of the discounts applied to the line item, separated by an HTML line break.
[[LineItem.ExtraShipCharge]] *	Gift Card, Order	If there were any additional shipping charges specified in the product, they will be reflected here in the same format as the store currency.
[[LineItem.LineTotal]] *	Gift Card, Order	The cumulative total of the line item, which usually accounts for promotions.
[[LineItem.ProductDescription]] *	Gift Card, Order	The description of the product matching this line item.
[[LineItem.ProductId]] *	Gift Card, Order	The unique ID or bvin of the product matching this line item.
[[LineItem.ProductName]] *	Gift Card, Order	The language-friendly name of the product matching this line item.
[[LineItem.ProductSku]] *	Gift Card, Order	The unique SKU of the product matching this line item.
[[LineItem.Quantity]] *	Gift Card, Order	This is the total quantity that the customer has ordered for this line item.
[[LineItem.QuantityReturned]] *	Gift Card, Order	Used to define how many products in this line item have been returned. It's likely to always be zero, except after an inventory replenishment process has occurred.
[[LineItem.QuantityShipped]] *	Gift Card, Order	Reflects how many of this line item have been shipped so far.
[[LineItem.ShipFromAddress]] *	Gift Card, Order	The address of the source where the product will be shipped from. This is usually the store address, unless you're using drop shipping.  This address will be rendered using an HTML new line for each section of the address.  You should only use this when all of your products come from different addresses.
[[LineItem.ShippingPortion]] *	Gift Card, Order	The amount of shipping that was spread into this line from the entire order.
[[LineItem.ShippingStatus]] *	Gift Card, Order	Reflects the shipping status for this specific line item.
[[LineItem.ShipSeparately]] *	Gift Card, Order	Reflects whether the matching product for this line item must be shipped separately or not.  You'll either see a "Yes" or "No" when used.
[[LineItem.Sku]] *	Gift Card, Order	Obsolete.  Please use the [[LineItem.ProductSku]] token instead.
[[LineItem.TaxPortion]] *	Gift Card, Order	The amount of tax that was spread into this line from the entire order.  This will be represented in the same currency format as the store.
[[LineItem.TaxRate]] *	Gift Card, Order	The rate that the products this line item should be taxed at, such as 8.75%.
[[LineItem.LineTotalBeforeVAT]] *	Gift Card, Order	This is the [[LineItem.LineTotal]], minus [[LineItem.TaxPortion]], represented in the same currency format as the store.
[[LineItem.VariantId]] *	Gift Card, Order	If the product is a variant, this will contain the unique ID or bvin of the matching variant.
[[NewPassword]]	Forgot Password Template	If the site settings allow it, this will be replaced with the password for the customer.
[[Order.AdminLink]]	Order	Returns the link to see and manage the order in the administration area. This is only meant for templates that store personnel will receive.
[[Order.AffiliateId]]	Order	If the order is being attributed to an affiliate, this ID will reflect that.  Otherwise, it will be empty.
[[Order.BillingAddress.City]]	Order	This is the city name the customer specified as the city of the billing address.
[[Order.BillingAddress.Company]]	Order	This is the company name the customer specified for the billing address.  Most often, this is empty.
[[Order.BillingAddress.CountryName]]	Order	This will return the display name of the country for the billing address, as specified by the customer.
[[Order.BillingAddress.Fax]]	Order	If specified, this will be the facsimile number given by the customer for the billing address.
[[Order.BillingAddress.FirstName]]	Order	Replaced by the first name for the billing address.
[[Order.BillingAddress.LastName]]	Order	Replaced by the first name for the billing address.
[[Order.BillingAddress.Line1]]	Order	This will be replaced by the first line of the billing street address. It will often look something like "123 Main Street."
[[Order.BillingAddress.Line2]]	Order	If specified, this will be the second line of the billing street address, such as "Suite 123" or "Apt Z."
[[Order.BillingAddress.Line3]]	Order	This is the third line of the billing street address. Usually used for non-US or military addresses.
[[Order.BillingAddress.MiddleInitial]]	Order	Replaced by the middle initial of the name for the billing address.
[[Order.BillingAddress.NickName]]	Order	When specified, this will be the value specified in the address book for the customer.  You know that this address was saved and populated prior to reaching the checkout page.
[[Order.BillingAddress.Phone]]	Order	If specified, this will be replaced with the billing phone number, as entered by the customer.
[[Order.BillingAddress.PostalCode]]	Order	You'll generally always see this replaced for North American billing addresses, but will often be blank for many international addresses.
[[Order.BillingAddress.RegionName]]	Order	This will return the display name of the region (a.k.a., state) for the billing address, as specified by the customer.
[[Order.BillingAddress.WebSiteUrl]]	Order	This will be replaced with the website URL assigned to the billing address. It's primarily used for vendors and manufacturers.
[[Order.BillingAddress]]	Order	This will be replaced with all of the billing address values.  The address will be rendered using an HTML new line for each section of the address.
[[Order.Bvin]]	Order	This is the primary key to uniquely identify a single order.  It's not the same thing as the order number.
[[Order.Coupons]]	Order	If any coupon codes have been recorded for the order, they will be replaced here.  If more than one coupon code is present, each will be replaced by a comma.  When there are no coupon codes, it will be an empty value.
[[Order.FraudScore]]	Order	This will be replaced with the fraud score value, as defined by your configuration.  It will generally be a small decimal value such as 0.0 or 2.5.
[[Order.GrandTotal]]	Order	The order grand total that includes all discounts, shipping, and VAT.  This value will be replaced using the same currency format as the store.
[[Order.Instructions]]	Order	Represents the special instructions saved by the customer when submitting the order.
[[Order.ItemsTax]]	Order	Total amount of tax for the line items in the order, in the same currency format specified in the store settings.
[[Order.LastUpdated]]	Order	The date and time that the order was last updated. This value will have been converted to the store time, from UTC.
[[Order.OrderDiscounts]]	Order	The sum of the discounts being applied to this order, excluding shipping discounts.  This value will be in the same currency format as found in the store settings.
[[Order.OrderNumber]]	Order	A numerically sequenced number is generated for each order as it is placed during checkout. This token represents that number.
[[Order.Payment.PoNumber]]	Order	If the order was placed using the purchase order (PO) payment method, the PO number will replace this token. If a PO number is not found (another payment method was used), this token will be removed.
[[Order.PaymentMethod]]	Order	This will be replaced by a single line listing of each payment method used, and the amount applied using that payment method.  An example of this might be "$123.45 | Credit Card 9876."
[[Order.PaymentStatus]]	Order	Reflects the current payment status for the order.
[[Order.PublicNotes]]	Order	If the merchant has communicated any public notes during order management tasks, they will be represented here.
[[Order.ShippingAddress.City]]	Order	This is the city name the customer specified as the city of the shipping address.
[[Order.ShippingAddress.Company]]	Order	This is the company name the customer specified for the shipping address.
[[Order.ShippingAddress.CountryName]]	Order	This will return the display name of the country for the shipping address, as specified by the customer.
[[Order.ShippingAddress.Fax]]	Order	If specified, this will be the facsimile number given by the customer for the shipping address.
[[Order.ShippingAddress.FirstName]]	Order	Replaced by the first name for the shipping address.
[[Order.ShippingAddress.LastName]]	Order	Replaced by the last name for the shipping address.
[[Order.ShippingAddress.Line1]]	Order	This will be replaced by the first line of the shipping street address. It will often look something like "123 Main Street."
[[Order.ShippingAddress.Line2]]	Order	If specified, this will be the second line of the shipping street address, such as "Suite 123" or "Apt Z."
[[Order.ShippingAddress.Line3]]	Order	This is the third line of the shipping street address. Usually used for non-US or military addresses.
[[Order.ShippingAddress.MiddleInitial]]	Order	Replaced by the middle initial of the name for the shipping address.
[[Order.ShippingAddress.NickName]]	Order	When specified, this will be the value specified in the address book for the customer.  You know that this address was saved and populated prior to reaching the checkout page.
[[Order.ShippingAddress.Phone]]	Order	If specified, this will be replaced with the shipping phone number, as entered by the customer.
[[Order.ShippingAddress.PostalCode]]	Order	You'll generally always see this replaced for North American billing addresses, but will often be blank for many international addresses.
[[Order.ShippingAddress.RegionName]]	Order	This will return the display name of the region (a.k.a., state) for the billing address, as specified by the customer.
[[Order.ShippingAddress.WebSiteUrl]]	Order	This will be replaced with the website URL assigned to the shipping address. It's primarily used for vendors and manufacturers.
[[Order.ShippingAddress]]	Order	This will be replaced with all of the shipping address values.  The address will be rendered using an HTML new line for each section of the address.
[[Order.ShippingDiscounts]	Order	This is replaced with a sum of all of the shipping discounts applied to the order, in the same currency format as the store settings.  An example of this might be -$123.45.
[[Order.ShippingMethod]]	Order	The name of the shipping method used, or a similar message when more or less than one shipping method is used.
[[Order.ShippingStatus]]	Order	Reflects the shipping status for the order.
[[Order.ShippingTax]]	Order	Total tax charged for shipping on the order, in the same currency format as specified in the store settings.  An example of this might be $123.45.
[[Order.ShippingTaxRate]]	Order	The rate that the shipping should be taxed at for this order, such as 8.75%.
[[Order.ShippingTotal]]	Order	Total amount for shipping before discounts are applied, in the same format as the store currency settings.  An example of this might be $123.45.
[[Order.ShippingTotalMinusDiscounts]]	Order	Will be replaced by the [[Order.ShippingTotal]], minus the shipping discounts for the order.  This will be displayed in the currency format you specified in the store settings.  An example of this might be $123.45.
[[Order.Status]]	Order	This will be replaced with the current order status.
[[Order.StoreAddress]]	Order	This is the store address and it will be rendered using an HTML new line for each section of the address.
[[Order.SubTotal]]	Order	The order total without discounts applied, but with user supplied price line items included. This does not include shipping charges.  An example of this might be $123.45.
[[Order.SubTotalMinusDiscounts]]	Order	This will be replaced with the [[Order.ShippingTotal]], minus [[Order.ShippingDiscounts]], in the same format as the store currency settings.  An example of this might be $123.45.
[[Order.TaxTotal]]	Order	Represents the total amount of tax for the order, using the same currency settings specified in the store settings.  An example of this might be $123.45.
[[Order.TimeOfOrder]]	Order	This will be replaced with the date and time that the order was placed. This time stamp will have been converted into the store time, from UTC.
[[Order.TotalAsTable]]	Order	An HTML table representation of the order summary, include all of the details about how the total was generated. This table and it's formatting can't be changed.
[[Order.TotalQuantity]]	Order	The sum of the quantity of all line items in the order.
[[Order.TotalShippingAfterDiscounts]]	Order	Replaced with the total amount for shipping after discounts are applied.  An example of this might be $123.45.
[[Order.TotalWeight]]	Order	A grand total of the weight of the line items in the order.
[[Order.TrackingNumberLinks]]	Order	Obsolete.  Use [[Order.TrackingNumbers]] instead.
[[Order.TrackingNumbers]]	Order	Builds and emits an HTML unordered list containing each of the tracking numbers for the line items in the order. These tracking numbers will not be linked to their respective shipping provider tracking pages.
[[Order.UserEmail]]	Order	This will be replaced with the e-mail address of the customer user account.
[[Order.UserID]]	Order	The User ID of the customer's user account.
[[Order.UserName]]	Order	The username associated with the customer's user account.
[[Order.VATRegistrationNumber]]	Order	If it exists, this will be replaced with the tax exemption number specified in the customer's user account.
[[RepeatingSection]]	Order	This is a placeholder that represents the repeating chunk of HTML that will be repeated for each line item or gift card in the order e-mail templates.
[[Store.Address]]	All	This is the store address and it will be rendered using an HTML new line for each section of the address.
[[Store.ContactEmail]]	All	This will be replaced with the primary e-mail address specified in your store settings.
[[Store.CurrentLocalTime]]	All	Returns the current time from the store without any conversions.
[[Store.CurrentUtcTime]]	All	Returns the current time from the store in UTC format.
[[Store.Logo]]	All	This is replaced with the HTML necessary to render a linked logo of your store.  This is an HTML anchor, wrapping an image tag.  The logo source path is specified in your store settings.
[[Store.RawStoreName]]	All	The name of your store, as specified in your store settings.
[[Store.SecureUrl]]	All	This the root URL of your store, with the secure prefix, such as:  https://example.com.
[[Store.StandardUrl]]	All	This the root URL of your, such as:  http://example.com.
[[Store.StoreName]]	All	The name of your store, as specified in your store settings. This is originally populated from either your site name, or from the XML configuration file. So it may be different from the [[Store.RawStoreName]] in some instances.
[[User.Bvin]]	User	This represents the User ID of the customer user account.
[[User.Comment]]	User	Obsolete.  Please use [[User.Notes]] instead.
[[User.CreationDate]]	User	This is replaced with the date and time that the customer user account was initially created, converted from UTC.
[[User.Email]]	User	References the e-mail address associated with the customer user account.
[[User.FirstName]]	User	This will be the first name of the customer, as specified in their user account.
[[User.LastLoginDate]]	User	This is replaced with the date and time that the customer last logged into the site, converted from UTC.
[[User.LastName]]	User	This will be the first name of the customer, as specified in their user account.
[[User.LastUpdated]]	User	This is replaced with the date and time that the customer user account was last saved, converted from UTC.
[[User.Locked]]	User	If the customer account has been locked by an administrator or due to too many failed logins, it will be locked. If it is locked, this value will be "true" and it will be "false" otherwise.
[[User.LockedUntil]]	User	If the customer user account is locked, this will let you know what the date and time is that the account will become automatically unlocked, converted from UTC.
[[User.NewRoles]]	User	If the customer has been added to new security roles, this will be replaced with those roles. This will happen as a result of a membership product type.  If there is more than one role added, each role will be separated by a comma.
[[User.Notes]]	User	This will be replaced with the information saved in the customer's notes field in the administration area.
[[User.Password]]	User	If the site configuration allows it, this token will be replaced with the password of the customer user account.
[[User.UserName]]	User	The username associated with the customer's user account.

*Line Item and Gift Card tokens are only found and replaced when used in the repeating section part of your e-mail template.