Working with Email Tokens

When working with email templates (see Email Templates for the creation of them and Email Templates for their use in Experience Management), there is a set of tokens that can be included in the email body to customize and personalize each email.  When the email is sent, these tokens will be replaced dynamically with the information that they represent.

Type of Tokens

There are two types of tokens:

Token Structure

Tokens have a specific format which allows them to be identified for replacement when an email is sent.  Tokens are  contained within braces and preceded by a dollar sign, as in ${first_name} and ${last_name}.

Token Replacement

Care should be taken when including tokens in an email.  If a token cannot be translated at the time that the email is processed for sending, the processing will be halted and the email will not be sent.  This can be prevented by providing alternatives if the token cannot be translated.  The two types of alternatives are:

There are additional commands available for performing advanced actions with tokens, such as iteratoring over groups of items.  For information on those commands, refer to the following website:  

http://jakarta.apache.org/velocity/docs/vtl-reference-guide.html

Available Tokens

This list contains the most commonly used email tokens. Due to the variations in what is included in the pipeline session, there may be additional valid tokens that are not included in this list.

Token

Token Name

Description

${cart.items.count}

Number of Items in Current Cart

The number count of items in the user’s current Shopping Cart. This information is not known for users whose session has expired.

${cart.items.item-1.color_name}

${cart.items.item-2.color_name}

${cart.items.item-3.color_name}

${cart.items.item-4.color_name}

${cart.items.item-5.color_name}

Item in Cart Item Color

The tokens contain the color name of each item.

${cart.items.item-1.description}

${cart.items.item-2.description}

${cart.items.item-3.description}

${cart.items.item-4.description}

${cart.items.item-5.description}

Item in Cart Description

The description of each item in the cart.

${cart.items.item-1.image_name_price_html}

${cart.items.item-2.image_name_price_html}

${cart.items.item-3.image_name_price_html}

${cart.items.item-4.image_name_price_html}

${cart.items.item-5.image_name_price_html}

Items in Cart Info (Item and Name format)

Five tokens to represent up to five items in the user's current Shopping Cart. The token displays as the Item-Mini Img, Name & Price content format showing the mini sized image, name, and price below it for the item in their Cart and is for HTML emails only. The item image, item name, and price link back to the item on the Web site. This information is not known for users whose session has expired.

${cart.items.item-1.image_src}

${cart.items.item-2.image_src}

${cart.items.item-3.image_src}

${cart.items.item-4.image_src}

${cart.items.item-5.image_src}

Item in Cart Item Image URL

URL for item image.

${cart.items.item-1.item_buy_online_inventory_message}

${cart.items.item-2.item_buy_online_inventory_message}

${cart.items.item-3.item_buy_online_inventory_message}

${cart.items.item-4.item_buy_online_inventory_message}

${cart.items.item-5.item_buy_online_inventory_message}

Item in Cart buy online inventory message

Message indicating if the item is in-stock.

${cart.items.item-1.item_discount}

${cart.items.item-2.item_discount}

${cart.items.item-3.item_discount}

${cart.items.item-4.item_discount}

${cart.items.item-5.item_discount}

Item in Cart discount

The value of any discount applied to the item.

${cart.items.item-1.item_discount_quantity}

${cart.items.item-2.item_discount_quantity}

${cart.items.item-3.item_discount_quantity}

${cart.items.item-4.item_discount_quantity}

${cart.items.item-5.item_discount_quantity}

Item Quantity discounted

The quantity of the item that is being discounted.

${cart.items.item-1.item_discount_total}

${cart.items.item-2.item_discount_total}

${cart.items.item-3.item_discount_total}

${cart.items.item-4.item_discount_total}

${cart.items.item-5.item_discount_total}

Item Discount total

The total amount of discount applied to the item (discount * quantity).

${cart.items.item-1.item_quantity}

${cart.items.item-2.item_quantity}

${cart.items.item-3.item_quantity}

${cart.items.item-4.item_quantity}

${cart.items.item-5.item_quantity}

Item in Cart Item Quantity

The quantity of each line item in the cart.

${cart.items.item-1.item_quantity_backordered}

${cart.items.item-2.item_quantity_backordered}

${cart.items.item-3.item_quantity_backordered}

${cart.items.item-4.item_quantity_backordered}

${cart.items.item-5.item_quantity_backordered}

Item quantity backordered

The quantity of the item that has been backordered.

${cart.items.item-1.item_quantity_preordered}

${cart.items.item-2.item_quantity_preordered}

${cart.items.item-3.item_quantity_preordered}

${cart.items.item-4.item_quantity_preordered}

${cart.items.item-5.item_quantity_preordered}

Item quantity preordered

The quantity of the item that has been preordered.

${cart.items.item-1.item_shipping}

${cart.items.item-2.item_shipping}

${cart.items.item-3.item_shipping}

${cart.items.item-4.item_shipping}

${cart.items.item-5.item_shipping}

Item shipping cost

The cost of shipping the item.

${cart.items.item-1.item_shipping_discount}

${cart.items.item-2.item_shipping_discount}

${cart.items.item-3.item_shipping_discount}

${cart.items.item-4.item_shipping_discount}

${cart.items.item-5.item_shipping_discount}

Item shipping discount

The amount of shipping discount for each item.

${cart.items.item-1.item_size_name}

${cart.items.item-2.item_size_name}

${cart.items.item-3.item_size_name}

${cart.items.item-4.item_size_name}

${cart.items.item-5.item_size_name}

Item size

The size of the item.

${cart.items.item-1.item_status}

${cart.items.item-2.item_status}

${cart.items.item-3.item_status}

${cart.items.item-4.item_status}

${cart.items.item-5.item_status}

Item status

The status of the item.

${cart.items.item-1.item_store_pickup_inventory_message}

${cart.items.item-2.item_store_pickup_inventory_message}

${cart.items.item-3.item_store_pickup_inventory_message}

${cart.items.item-4.item_store_pickup_inventory_message}

${cart.items.item-5.item_store_pickup_inventory_message}

Item store pickup availability message

Message indicating if the item is available for in-store pickup.

${cart.items.item-1.item_tax_total}

${cart.items.item-2.item_tax_total}

${cart.items.item-3.item_tax_total}

${cart.items.item-4.item_tax_total}

${cart.items.item-5.item_tax_total}

Item tax total

The tax total of the item

${cart.items.item-1.link}

${cart.items.item-2.link}

${cart.items.item-3.link}

${cart.items.item-4.link}

${cart.items.item-5.link}

Item in Cart Item URL

This token is for text email use and lists the URL to the item page for up to five items in the Shopping Cart. This can be used for HTML or text emails.

${cart.items.item-1.name}

${cart.items.item-2.name}

${cart.items.item-3.name}

${cart.items.item-4.name}

${cart.items.item-5.name}

Item in Cart Name

The item name alone. This can be used for HTML or text emails.

${cart.items.item-1.name_price}

${cart.items.item-2.name_price}

${cart.items.item-3.name_price}

${cart.items.item-4.name_price}

${cart.items.item-5.name_price}

Item in Cart Name and Price

These tokens are for text emails and list the item name and display price (not MSRP if exists) for up to five items in the Shopping Cart. This can be used for HTML or text emails.

${cart.items.item-1.price}

${cart.items.item-2.price}

${cart.items.item-3.price}

${cart.items.item-4.price}

${cart.items.item-5.price}

Item in Cart Price

The item display price (no MSRP if exists). This can be used for HTML or text emails.

${cart.items.item-1.price.currency}

${cart.items.item-2.price.currency}

${cart.items.item-3.price.currency}

${cart.items.item-4.price.currency}

${cart.items.item-5.price.currency}

Item in Cart Price Currency

The item display price (no MSRP if exists). This can be used for HTML or text emails.

${cart.subtotal}

Current Card Subtotal

Current shopping cart subtotal (not including estimated shipping or tax). This information is not known for users whose session has expired.

${cart.subtotal.currency}

Current Cart Subtotal Currency

Current Shopping Cart sub-total (not including estimated shipping or tax). This information is not known for users whose session has expired.

${curorder.carrier_code}

Current Order Carrier Code

The shipper code defined for the current order.

${curorder.gift_message}

Current Order Gift Message

The gift message defined for the current order.

${curorder.order_gift_wrap_discount_total}

Current Order Gift Wrap Discount Total

The discount gift wrap total for the current order.

${curorder.order_gift_wrap_non_discount_total}

Current Order Gift Wrap Non Discount Total

The non-discount gift wrap total for the current order.

${curorder.order_items_total}

Current Order Items Total

The total items for the current order.

${curorder.order_shipment_total}

Current Order Shipment Total

The shipment total for the current order.

${curorder.order_shipping}

Current Order Shipping

The shipping quantity for the current order.

${curorder.order_tax}

Current Order Tax

The tax amount for the current order.

${curorder.ship_from_store_order}

Current Order Ship From Store Order

Indicates whether the order is a ship from store order, indicating the items on the order ship from a retail store rather than a distribution center or warehouse.

${curorder.shipping_address.ADDRESS_LINE_1}

Current Order Shipping Address Line 1

The ship to street address for the current order.

${curorder.shipping_address.ADDRESS_LINE_2}

Current Order Shipping Address Line 2

The second address line for the ship to address on the current order.

${curorder.shipping_address.APARTMENT}

Current Order Shipping Address Apartment

The apartment for the ship to address on the current order.

${curorder.shipping_address.CITY}

Current Order Shipping Address City

The city for the ship to address on the current order.

${curorder.shipping_address.FIRST_NAME}

Current Order Shipping Address First Name

The first name for the ship to address on the current order.

${curorder.shipping_address.LAST_NAME}

Current Order Shipping Address Last Name

The last name for the ship to address on the current order.

${curorder.shipping_address.PHONE}

Current Order Shipping Address Phone

The phone number for the ship to address on the current order.

${curorder.shipping_address.STATE}

Current Order Shipping Address State

The state for the ship to address on the current order.

${curorder.shipping_address.STORE_HOURS}

Current Order Shipping Address Store Hours

The store hours for the store assigned to the current order for store pickup items.

${curorder.shipping_address.STORE_NAME}

Current Order Shipping Address Store Name

The name of the store assigned to the current order for store pickup.

${curorder.shipping_address.ZIP_CODE}

Current Order Shipping Address Zip Code

The postal code for the ship to address on the current order.

${customer-service-email}

Customer Service Email

Shortcut link to email address for customer service.

${date}

Date Default Format

The date the email was sent by the system formatted as MM/DD/YYYY.

${date.long}

Date Long Format

The date the email was sent by the system formatted as Month DD, YYYY.

${date.time}

Date Time

The time the email was sent by the system displaying as HH:MM am/pm

${date.with_weekday}

Date With Weekday Format

The date the email was sent by the system formatted as week day, Month DD, YYYY.

${email_address}

Email Address

The user’s email address. Available for all users.

${email_form_link}

Link to Contact us Email Form

Shortcut link to contact us email form on Web site. Enter in HTML as: <a href=${email_form_link}>Email us</a>.

${email_opened_image_src}

Track HTML Email Opened Events

Hidden image token that can be put anywhere in the HTML email to track email opened events.

${entity.display.price}

Entity Display Price

The display price of the product or ensemble that is currently being viewed by the user.

${entity.link}

Entity Link

This token contains a link to the product/ensemble detail page.

${entity.name}

Entity Name

This token contains the name of the product/ensemble.

${first_name}

First Name

The user’s first name. Not available for anonymous users whose session has expired.

${full_name}

Full Name

The user’s first and last name. Not available for anonymous users whose session has expired.

${gc.pin}

Gift Card Pin

The gift card pin number used to redeem the gift card amount.

${gc.purchase_amount}

Gift Card Purchase Amount

The amount of the gift card.

${gc.purchase_date}

Gift Card Purchase Date

The date the gift card was purchased.

${gc.purchaser_message}

Gift Card Purchaser Message

The gift message written by the purchaser for the gift card.

${gc.purchaser_name}

Gift Card Purchaser Name

The name of the person who purchased the gift certificate.

${gc.recipient_name}

Gift Card Recipient Name

The name of the person to receive the gift card.

${gc.redemption_code}

Gift Card Redemption Code

The gift card redemption code used to redeem the gift card amount.

${home_page_link}

Link to Home Page

Shortcut link to home page of Web site. Enter in HTML as: Return to <a href=${home_page_link}> Store.com</a>.

${item.color_name}

Item Color Name

The color of the item.

${item.gc_message}

Item Gift Card Message

The gift card message defined for the item.

${item.gc_recipient_email}

Item Gift Card Recipient Email

The email address of the person receiving the gift certificate.

${item.gc_recipient_name}

Item Gift Card Recipient Name

The name of the person receiving the gift card.

${item.gc_type}

Item Gift Card Type

The type of gift card.

${item.gift_wrap}

Item Gift Wrap

Indicates whether gift wrap was selected for the item.

${item.item_canceled_total}

Item Cancelled Total

The total price amount of the item that was cancelled.

${item.item_discount_quantity}

Item Discount Quantity

The quantity of the item on discount.

${item.item_list_price}

Item List Price

The list price for the item.

${item.item_quantity}

Item Quantity

The item quantity.

${item.item_quantity_canceled}

Item Quantity Cancelled

The quantity of the item that was cancelled.

${item.item_status}

Item Status

The status of the item.

${item.item_store_pickup_inventory_message}

Item Store Pickup Inventory Message

The inventory message defined for a store pickup item.

${item.item_total}

Item Total

The item total.

${item.link}

Item Link

A link to the item on the web site.

${item.name}

Item Name

The name of an item.

${item.size_name}

Item Size Name

The size of the item.

${last_name}

Last Name

The user’s last name. Not available for anonymous users whose session has expired.

${locate-order-number}

Oracle Retail Order Broker Cloud Service Order Number

This token contains the Oracle Retail Order Broker Cloud Service order number if Oracle Retail Order Broker Cloud Service was used to find the inventory for the order.

${order.billing_address}

Billing Address of Order

This token can be used to determine if a billing address exists for the last order.

${order.billing_address.ADDRESS_LINE_1}

Address Line 1 of Billing Address

This token contains the first line of the street address where the last order was billed to.

${order.billing_address.ADDRESS_LINE_2}

Address Line 2 of Billing Address

This token contains the second line of the street address where the last order was billed to.

${order.billing_address.APARTMENT}     

Billing Address Apartment Number

This token contains the apartment number of the street address where the last order was billed to.

${order.billing_address.CITY}

Billing Address City

This token contains the city of the billing address that the last order was billed to.

${order.billing_address.COUNTRY}

Billing Address Country

This token contains the country of the billing address for the last order.

${order.billing_address.FIRST_NAME}

First Name of Billing Address

This token contains the first name of the billing address for the last order.

${order.billing_address.LAST_NAME}

Last Name of Billing Address

This token contains the last name of the billing address for the last order.

${order.billing_address.PHONE}

Billing Address Phone Number

This token contains the phone number of the billing address for the last order.

${order.billing_address.STATE}

Billing Address State

This token contains the state of the billing address for the last order.

${order.billing_address.ZIP_CODE}

Billing Address Zip Code

This token contains the zip code of the billing address of the last order.

${order.cancel_reason}

Order Cancellation Reason

This token contains the cancellation reason if the order was cancelled.

${order.cc_total}

Order Amount Charged to Credit Card

This order contains the total amount charged to a credit card for the order.

${order.channel}

Order Channel

This token contains the channel that the order was placed through, i.e. “online”.

${order.credit_card_type}

Order Credit Card Type

This token contains the type of the credit card. It can be used to determine if the payment was done via gift card or PayPal. The value will be “GC” for gift card/gift certificate or “PP” for PayPal.

${order.date}

Last Order Date

Date of last order placed. This is only applicable for members who have either a current or expired session. The display for the order date will be the same as the default for current date: MM/DD/YYYY.

${order.gc_total}

Gift Card/ Electronic Gift Certificate Total

This token contains the total amount of gift cards and/or electronic gift certificates that were used to pay for the order.

${order.grand_gift_wrap_discount_total}

Discounted Gift Wrap Total

This token contains the discount amount applied to gift wrapping.

${order.grand_gift_wrap_non_discount_total}

Non-Discounted Gift Wrap Total

This token contains the original cost of gift wrapping.

${order.grand_gift_wrap_total}

Last Order Total of all Gift Wrap Charges

Grand total amount of all gift wrap charges in the last placed order.  This is only applicable for members who have either a current or expired session.

${order.grand_items_total}

Items Total

This token contains the total amount of all the items in the order.

${order.grand_orders_discount_total}

Order Discount Total

This token contains the total amount of all discounts applied to the order.

${order.grand_orders_shipping_discount}

Shipping Discount Total

This token contains the amount of discount applied to shipping.

${order.grand_shipping}

Shipping Total

This token contains the total shipping cost (original shipping – shipping discounts) for the last order.

${order.grand_shipping_rate}

Shipping Rate

This token contains the total shipping cost (original shipping – shipping discounts) for the last order.

${order.grand_tax}

Order Tax

This token contains the total amount of tax for the order.

${order.grand_total.currency}

Last Order Total

Grand total amount of last placed order (including tax, shipping, and any order discounts). This is only applicable for members who have either a current or expired session.

${order.grand_total}

Last Order Grand Total

Grand total amount of last placed order (including tax, shipping, and any order discounts). This is only applicable for members who have either a current or expired session.

${order.items.back_ordered_message}

Last Order Item Back Ordered Message

A back ordered message (if applicable) associated with this item.

${order.items.color_name}

Last Order Item Color Name

The name of the color of this item.

${order.items.count}

Number of Items in Last Order

The number count of items in the users last placed order. This information is not known for anonymous users who either do or do not have a current session.

${order.items.gift_wrap}

Last Order Item Gift Wrap

The gift wrap charge for this item.

${order.items.item-1.image_name_price_html}

${order.items.item-2.image_name_price_html}

${order.items.item-3.image_name_price_html}

${order.items.item-4.image_name_price_html}

${order.items.item-5.image_ngifame_price_html}

Last Order Items

Five tokens to represent up to five items in the user's last order. The token displays as the Item-Mini Img, Name & Price content format showing the mini sized image, name, and price below it for the item in their Cart and is for HTML emails only. The item image and item name and price will be links back to the item on the Web site. This information is not known for users whose session has expired.

${order.items.item-1.image_src}

${order.items.item-2.image_src}

${order.items.item-3.image_src}

${order.items.item-4.image_src}

${order.items.item-5.image_src}

Last Order Item Image URL

URL for item image.

${order.items.item-1.link}

${order.items.item-2.link}

${order.items.item-3.link}

${order.items.item-4.link}

${order.items.item-5.link}

Last Order Item URL

This token is for text email use and lists the URL to the item page for up to five items in the user’s last order. This can be used for HTML or text emails.

${order.items.item-1.name}

${order.items.item-2.name}

${order.items.item-3.name}

${order.items.item-4.name}

${order.items.item-5.name}

Last Order Item Name

The item name alone. This can be used for HTML or text emails.

${order.items.item-1.name_price}

${order.items.item-2.name_price}

${order.items.item-3.name_price}

${order.items.item-4.name_price}

${order.items.item-5.name_price}

Last Order Item Name and Price

These tokens are for text emails and list the item name and display price (not MSRP if exists) for up to five items in the Shopping Cart.

${order.items.item-1.price.currency}

${order.items.item-2.price.currency }

${order.items.item-3.price.currency }

${order.items.item-4.price.currency }

${order.items.item-5.price.currency }

Last Order Item Price

The item display price (no MSRP if exists). This can be used for HTML or text emails.

${order.items.item_discount}

Last Order Item Discount

The discount amount for this item.

${order.items.item_discount_quantity}

Last Order Item Discount Quantity

The quantity of this item that a discount was applied to.

${order.items.item_discount_total}

Last Order Item Discount Total

The total discount applied to this item.

${order.items.item_quantity}

Last Order Item Quantity

The quantity purchased for the item in the last order.

${order.items.item_total}

Last Order Item Total

The purchase total of this item.

${order.items.list_price}

Last Order Items List Price

The list price of this item.

${order.items.name}

Last Order Item Name

The name of the item purchased in the last order.

${order.items.size_name}

Last Order Item Size Name

The name of the size of this item.

${order.number}

Last Order Number

Order number of last order placed. Token can be made a link if user uses the link token. This is only applicable for members who have either a current or expired session.

${order.order_gift_wrap_total}

Last Order Gift Wrap Total Per Shipping Address

Gift wrap total for a shipping address for the last order.

${order.order_date}

Order Date

This token contains the date the order was placed on.

${order.order_items_total}

Last Order Item Total Per Shipping Address

Item total for a shipping address for the last order.

${order.order_shipping}

Last Order Shipping Total per Shipping Address

Shipping total for a shipping address for the last order.

${order.order_status_code}

Order Status Code

This token contains the order’s status code.

${order.order_tax}

Last Order Tax Total Per Shipping Address

Tax total for a shipping address for the last order.

${order.orders}

Orders of Last Order Collection

The list of orders in the last order collection that was placed. This list can be iterated over in order to get specific information from each order.

${order.orders.carrier_code}

Order Carrier Code

This token contains the carrier code for the order. This token should be used when iterating over the orders in the order collection.

${order.orders.display_remaining_item_section}

Display Remaining Items

This token contains a flag that indicates whether or not remaining items should be displayed. The value will be “Y” is they are to be displayed. This toke should be used when iterating over the orders in the order collection.

${order.orders.gift_message}

Order Gift Message

This token contains the gift message if this order is a gift. This token should be used when iterating over the orders in the order collection.

${order.orders.instore_pickup_order}

In-store pickup order

If set to “Y”, the order is set for in-store pickup. This token should be used when iterating over the orders in the order collection.

${order.orders.items}

Items in Order

This token contains the items in the order. It can be iterated over to retrieve each individual item. This token should be used when iterating over the items in an order.

${order.orders.items.color_name}

Item Color Name

This token contains the color name of the item. This token should be used when iterating over the items in an order.

${order.orders.items.gc_message}

Gift Card/ Electronic Gift Certificate Message

This token contains the purchaser’s gift message if the item is a gif card or electronic gift certificate. This token should be used when iterating over the items in an order.

${order.orders.items.gc_recipient_email}

Gift Card/ Electronic Gift Certificate Recipient Email

This token contains the email address of the recipient if the item is a gift card or electronic gift certificate. This token should be used when iterating over the items in an order.

${order.orders.items.gc_recipient_name}

Gift Card/ Electronic Gift Certificate Recipient Name

This token contains the name of the recipient of the item is a gift card or electronic gift certificate. This token should be used when iterating over the items in an order.

${order.orders.items.gc_type}  

Gift Card/ Electronic Gift Certificate Type

This token indicates if the item is a gift card/electronic gift certificate. Its value will be “GC_TYPE_GC” if the item is a gift card/certificate.

${order.orders.items.gift_wrap}

Item Gift Wrap

This token indicates if gift wrap was purchased for the item. The value will be “true” if it was.

${order.orders.items.item_buy_online_inventory_message}

Item Buy Online Inventory Message

This token contains the inventory message if the item was purchased online. This token should be used when iterating over the items in an order.

${order.orders.items.item_canceled_total}

Item Canceled Total Amount

This token contains the total monetary amount of the item that was canceled.

${order.orders.items.item_discount_quantity}

Item Quantity Discounted

This token contains the number of items that were discounted. This token should be used when iterating over the items in an order.

${order.orders.items.item_discount_total}

Item Discount Total

This token contains the total amount of discount for the item. This token should be used when iterating over the items in an order.

${order.orders.items.item_list_price}

Item List Price

This token contains the list price of the item. This token should be used when iterating over the items in an order.

${order.orders.items.item_quantity}

Item Quantity

This token contains the quantity of the item that was purchased. This token should be used when iterating over the items in an order.

${order.orders.items.item_quantity_canceled}

Item Quantity Canceled

This token contains the quantity of the item that has been canceled. This token should be used when iterating over the items in an order.

${order.orders.items.item_status}

Item Status

This token contains the status of the item. This token should be used when iterating over the items in an order.

${order.orders.items.item_store_pickup_inventory_message}

Item Store Pickup Inventory Message

This token contains the inventory message if the item was purchased for in‑store pickup. This token should be used when iterating over the items in an order.

${order.orders.items.item_total}

Item Total

This token contains the total amount of the item. This token should be used when iterating over the items in an order.

${order.orders.items.name}

Item Name

This token contains the name of the item. This token should be used when iterating over the items in an order.

${order.orders.items.remaining_items_count}

Count of Remaining Items

This token contains a count of the items in the order that have not yet been shipped. This token should be used when iterating over the items in an order.

${order.orders.items.remaining_items_exist}

Remaining Items Exist Flag

This token is a flag that indicates whether or not there are unshipped items in the order. This token should be used when iterating over the items in an order.

${order.orders.items.remaining_items_total}

Remaining Items Total

This token contains the total monetary amount of the remaining items in the order.

${order.orders.items.size_name}

Item Size Name

This token contains the size name of the item. This token should be used when iterating over the items in an order.

${order.orders.my_key}

Order type

Indicates the type of order and can be “GC_ORDER”

${order.orders.order_gift_non_discount_cost_total}

Gift Wrap Cost Non‑Discounted Total per Order

This token contains the non‑discounted gift wrap cost in each order in the order collection. This token should be used when iterating over the orders in the order collection.

${order.orders.order_gift_wrap_discount_total}

Gift Wrap Discounted Total per Order

This token contains the discounted gift wrap cost in each order in the order collection. This token should be used when iterating over the orders in the order collection.

${order.orders.order_gift_wrap_non_discount_total}

Gift Wrap Non‑Discount Total per Order

This token contains the non‑discounted gift wrap total in each order in the order collection. This token should be used when iterating over the orders in the order collection.

${order.orders.order_items_total}

Item Total per Order

This token contains the total of all items in the order, per order in the order collection. This token should be used when iterating over the orders in the order collection.

${order.orders.order_shipping}

Order Shipping Total

This token contains the total amount of shipping for the order. This token should be used when iterating over the orders in the order collection.

${order.orders.order_tax}

Total Order Tax

This token contains the total amount of tax for the order. This token should be used when iterating over the orders in the order collection.

${order.orders.ship_from_store_order}

Order Ship From Store Order Flag

This token indicates if the order is a ship from store order. This token should be used when iterating over the orders in the order collection.

${order.orders.order_shipment_total}   

Order Shipment Total

This token contains the total amount of the order that was shipped. This token should be used when iterating over the orders in the order collection.

${order.orders.shipping_address}

Shipping Address Per Order in Last Order

This token contains the shipping address of each order in the last order collection.

${order.orders.shipping_address.ADDRESS_LINE_1}

First Address Line in Shipping Address Per Order in Last Order

This token contains the first address line of each shipping address of each order in the last order collection.

${order.orders.shipping_address.ADDRESS_LINE_2}

Second Address Line in Shipping Address Per Order in Last Order

This token contains the second address line of each shipping address of each order in the last order collection.

${order.orders.shipping_address.APARTMENT}

Shipping Address Apartment Number Per Order in Last Order

This token contains the apartment number of each shipping address of each order in the last order collection.

${order.orders.shipping_address.CITY}

Shipping Address City Per Order in Last Order

This token contains the city of each shipping address of each order in the last order collection.

${order.orders.shipping_address.COUNTRY}

Shipping Address Per Order in Last Order

This token contains the country of each shipping address of each order in the last order collection.

${order.orders.shipping_address.FIRST_NAME}

Shipping Address Per Order in Last Order

This token contains the first name of each shipping address of each order in the last order collection.

${order.orders.shipping_address.LAST_NAME}

Shipping Address Per Order in Last Order

This token contains the last name of each shipping address of each order in the last order collection.

${order.orders.shipping_address.PHONE}

Shipping Address Per Order in Last Order

This token contains the phone number of each shipping address of each order in the last order collection.

${order.orders.shipping_address.STATE}

Shipping Address Per Order in Last Order

This token contains the state of each shipping address of each order in the last order collection.

${order.orders.shipping_address.STORE_HOURS}

Shipping Address Per Order in Last Order

This token contains the store hours of each shipping address of each order in the last order collection. This token has a value only if the order was an in-store pickup order.

${order.orders.shipping_address.STORE_NAME}

Shipping Address Per Order in Last Order

This token contains the store name of each shipping address of each order in the last order collection. This token has a value only if the order was an in-store pickup order.

${order.orders.shipping_address.ZIP_CODE}

Shipping Address Per Order in Last Order

This token contains the zip code of each shipping address of each order in the last order collection.

${order.orders.size}

Number of Orders in the Order Collection

This token indicates the number of orders, which are defined as separate shipments, in the order.

${order.paypal_payer_email}

Order PayPal Email Address

This token contains the email address of the customer’s PayPal account.

${order.paypal_express}

Order PayPal Express

This token is a flag that indicates whether or not the order was paid through PayPal Express. If set to “true”, it was.

${order.relate_rewards}

Order Oracle Retail Loyalty and Awards Cloud Service Rewards

This token contains the amount of the order that was paid with Oracle Retail Loyalty and Awards Cloud Service rewards.

${order.shipping_address.ADDRESS_LINE_1}

Order Shipping Address Line 1

The first address line associated with the shipping address for the order.

${order.shipping_address.ADDRESS_LINE_2}

Order Shipping Address Line 2

The second address line associated with the shipping address for the order.

${order.shipping_address.CITY}

Order Shipping Address City

The city associated with the shipping address for the order.

${order.shipping_address.FIRST_NAME}

Order Shipping Address First Name

The first name associated with the shipping address for the order.

${order.shipping_address.GIFT_MESSAGE}

Order Shipping Address Gift Message

The gift message (if any) entered for the shipping address for the last order.

${order.shipping_address.LAST_NAME}

Order Shipping Address Last Name

The last name associated with the shipping address for the order.

${order.shipping_address.STATE}

Order Shipping Address State

The state associated with the shipping address for the order.

${order.shipping_address.ZIP_CODE}

Order Shipping Address Zip Code

The zip code associated with the shipping address for the order.

${order_status_link}

Link to Order Status

Shortcut link to order status/history. Enter in HTML as: Check <a href=${order_status_link}>Order Status</a>. If the user is logged in they will be taken directly to their account Order History page. If they are not logged in they will be taken to the Order Status page.

${password}

Password

The password of the account associated with the current user.

${picked_date}

Date Order Picked Up In Store

Date an in-store order was picked up.

${recipient.name}

Email Recipient Name

Name of the person receiving the email.

${regularShipmentCount}

Regular Shipment Count

The number of items to ship on a regular order.

${reset-password-url}

Link to Reset Password

This token contains the link to the page to reset a user’s password.

${sender.message}

Email Sender Personal Message

Personal message from email sender.

${sender.name}

Email Sender Name

Name of the person sending the email.

${sender.source_display_price_for_email}

Entity Price

Source price of the product/ensemble.

${shopping_cart_link}

Link to Cart

Shortcut link to user’s Shopping Cart. Enter in HTML as: Return to your <a href=${shopping_cart_link}>Shopping Cart</a>.

${site.EMAIL_VERIFICATION_URL_LINK}

Email Verification Link

This token contains the link for email verification for new members.

${site.SITE_NAME}

Name of Site

This token contains the name of the site.

${site.SITE_URL}

Site URL

This token contains the URL of the site.

${site-name}

Name of Site

This token contains the name of the site.

${site-toll-free-number}

Site Phone Number

This token contains the toll free number phone number of the site. This token is used in the Email a Friend email template.

${site-url}

Link to Site

This token contains the link to the site.

${sitename}

Name of Site

The name of the site the email is associated with.

${status}

Order Status

The status of the order.

${store.number}

Store Number

The number of the store where the pickup item will be available.

${storeName}

Store Name

The name of the store an in-store pickup item will be available at.

${to_be_cancel}

In-store Pickup Availability Time Window

Amount of time before an in-store pickup item will be cancelled if not picked.

${userinfo.ADDRESS_LINE1}

User’s Address Line 1

The first address line of the user’s street address.

${userinfo.ADDRESS_LINE2}

User’s Address Line 2

The second address line of the user’s street address.

${userinfo.CITY}

User’s City

The user’s city.

${userinfo.FIRST_NAME}

User’s First Name

The user’s first name.

${userinfo.LAST_NAME}

User’s Last Name

The user’s last name.

${userinfo.PHONE}

User’s Phone Number

The user’s phone number.

${userinfo.REWARDS_ID}

User’s Rewards Number

The user’s loyalty rewards account number.

${userinfo.STATE}

User’s State

The user’s state.

${userinfo.ZIP_CODE}

User’s Zip Code

The user’s zip code.

${username}

User's Name

The username of the account associated with the current user.

${wish_list.items}

Items in Wish List

The list of items in the wish list.

${wish_list.items.color_name}

Wish List Item Color Name

The name of the color of an item in the wish list.

${wish_list.items.count}

Number of Items in Current Wish List

The number count of items in the users current Wish List. This information is not known for anonymous users who either have a current session or whose session has expired.

${wish_list.items.item-1.image_name_price_html}

${wish_list.items.item-2.image_name_price_html}

${wish_list.items.item-3.image_name_price_html}

${wish_list.items.item-4.image_name_price_html}

${wish_list.items.item-5.image_name_price_html}

Items in Wish List

Five tokens to represent up to three items in the user’s Wish List. The token displays as the Item-Mini Img, Name & Price content format showing the mini sized image, name, and price below it for the item in their Wish List and is for HTML emails only. The item image, item name, and price link back to the item on the Web site. This information is not known for anonymous users who either have a current session or whose session has expired.

${wish_list.items.item-1.image_src}

${wish_list.items.item-2.image_src}

${wish_list.items.item-3.image_src}

${wish_list.items.item-4.image_src}

${wish_list.items.item-5.image_src}

Wish List Item Image URL

URL for item image.

${wish_list.items.item-1.link}

${wish_list.items.item-2.link}

${wish_list.items.item-3.link}

${wish_list.items.item-4.link}

${wish_list.items.item-5.link}

Wish List Item URL

This token is for text email use and lists the URL to the item page for up to five items in the Wish List. This information is not known for anonymous users who either have a current session or whose session has expired.

${wish_list.items.item-1.name}

${wish_list.items.item-2.name}

${wish_list.items.item-3.name}

${wish_list.items.item-4.name}

${wish_list.items.item-5.name}

Wish List Item Name

The item name alone. This can be used for HTML or text emails.

${wish_list.items.item-1.name_price}

${wish_list.items.item-2.name_price}

${wish_list.items.item-3.name_price}

${wish_list.items.item-4.name_price}

${wish_list.items.item-5.name_price}

Wish List Item Name and Price

These tokens are for text emails and list the item name and display price (not MSRP if exists) for up to five items in the Wish List. This information is not known for anonymous users who either have a current session or whose session has expired. This can be used for HTML or text emails.

{wish_list.items.item-1.price}

${wish_list.items.item-2.price}

${wish_list.items.item-3.price}

${wish_list.items.item-4.price}

${wish_list.items.item-5.price}

Wish List Item Price

The item display price (no MSRP if exists). This can be used for HTML or text emails.

${wish_list.items.item-1.price.currency}

${wish_list.items.item-2.price.currency}

${wish_list.items.item-3.price.currency}

${wish_list.items.item-4.price.currency}

${wish_list.items.item-5.price.currency}

Wish List Item Price Currency

The item display price (no MSRP if exists). This can be used for HTML or text emails.

${wish_list.items.link}

Wish List Item URL

This token contains the link to the current wish list item. This token should be used when iterating over the list of items in the wishlist.

${wish_list.items.name}

Wish List Item Name

This token contains the name of the current wish list item. This token should be used with iterating over the list of items in the wish list.

${wish_list.items.quantity}

Wish List Item Quantity

The quantity of the item in the wish list.

${wish_list.items.size_name}

Wish List Item Size Name

The name of the size of an item in the wish list.

${wish_list.items.user_item_id}

Wish List User ID

The identification of the user for the wish list.

${wish_list_link}

Link to Wish List

Shortcut link to user’s wish list. Entered in HTML as: Return to your <a href=${wish_list_link}>Wish List</a>. If the user is logged in this link will take them directly to their Wish List. If they are not logged in they will be taken to the account log in page and upon successfully logging in will be taken to their Wish List page.

 

See also

Working with Tables

Working with the Text Editor

Working with the Clock

Working with Image Map Assets