IMPORTANT: As we revamp and transition our documentation to this site, you may find the articles you need on Liferay's Help Center.

Analytics Cloud Commerce DXP / Portal Liferay Cloud Reference

Documentation Menu

Highlighting

Remove Highlighting

Go Back

• Installation and Upgrades
• Starting a Store
• Product Management
• Creating Store Content
• Pricing
• Users and Accounts
• Order Management
• Inventory Management
• Store Management
  • Channels
  • Currencies
  • Configuring Payment Methods
  • Configuring Shipping Methods
  • Guest Checkout
  • Sending Emails
    • Using Notification Templates
    • Configuring the Commerce Notification Queue
    • Notification Template Variables Reference Guide
  • Liferay Commerce Configuration Overview
  • Adding Regions
  • Locale Options
  • Deactivating a Country for Billing or Shipping
• Add-ons and Connectors
• Developer Guide
• Get Help

English

• Japanese
• English
• English

• Liferay Learn
• Commerce
• Store Management
• Sending Emails
• Notification Template Variables Reference Guide

Notification Template Variables Reference Guide

When creating notification templates, you can use variables to populate email fields dynamically with data from the triggering channel event. Select a notification template Type to view its variables. This determines which channel events trigger the notification.

After selecting a type, you can view its variables and their descriptions by expanding Definition of Terms in the Email Settings and Email Content sections. Examples include the customer’s name, order ID, shipping and billing addresses, list of order items, and more.

Email Settings

Variable	Description
[%ACCOUNT_ROLE_ORDER_MANAGER%]	Account Order Manager
[%ORDER_CREATOR%]	The user that created the order
[%ACCOUNT_ROLE_ADMINISTRATOR%]	Account Administrator
[%USER_GROUP_NAME%]	User Group Name

Order Based Notification Template Types

Channels have six types of notification templates for order events:

1. Order Placed

2. Order Processing

3. Order Awaiting Shipment

4. Order Partially Shipped

5. Order Shipped

6. Order Completed

Variable	Description
[%ORDER_ITEMS%]	A table listing all items in the order
[%ORDER_SHIPPING_ADDRESS%]	The order’s shipping address
[%ORDER_BILLING_ADDRESS%]	The order’s billing address
[%ORDER_ID%]	The order ID
[%ORDER_TOTAL%]	The order’s total excluding tax
[%ORDER_DATE%]	The date when the order was placed
[%ORDER_CURRENCY_SYMBOL%]	The currency symbol of the order (Example: $, £)
[%ORDER_SHIPPING_WITH_TAX_TOTAL%]	The order’s total shipping cost including tax
[%ORDER_EXTERNAL_REFERENCE_CODE%]	The order’s external reference code
[%ORDER_URL%]	The order’s URL
[%PAYMENT_TERMS_DESCRIPTION%]	Payment terms attached to the order
[%ORDER_PAYMENT_METHOD%]	The order’s payment method
[%ORDER_TAX_TOTAL%]	The total tax for the order
[%ORDER_WITH_TAX_TOTAL%]	The total amount for the order including tax
[%ORDER_CREATOR_USER_FIRST_NAME%]	The first name of the user that created the order
[%ORDER_SHIPPING_OPTION%]	The order’s shipping option
[%ORDER_CREATOR_USER_LAST_NAME%]	The last name of the user that created the order
[%DELIVERY_TERMS_DESCRIPTION%]	Delivery terms attached to the order
[%ORDER_CREATOR%]	The user that created the order
[%ORDER_CURRENCY_CODE%]	The currency code of the order (Example: USD, GBP)
[%ORDER_CREATOR_USER_TITLE%]	The title of the user that created the order
[%ORDER_SHIPPING_TOTAL%]	The order’s total shipping cost excluding tax

Subscription Based Notification Template Types

Channels have four types of notification templates for subscription events:

1. Subscription Renewed

2. Subscription Activated

3. Subscription Suspended

4. Subscription Canceled

Variable	Description
[%PRODUCT_NAME%]	Product Name
[%ORDER_CREATOR%]	The user that created the order
[%ORDER_ID%]	The order ID

Additional Information

• Using Notification Templates

Not finding what you're looking for?

Pardon our dust as we revamp and transition our product documentation to this site. If something seems missing, please check Liferay Help Center documentation for Liferay DXP 7.2 and previous versions.

Try Liferay's Help Center