You can configure Global Commerce to send email notifications to shoppers or clients when a specific event occurs. You can use the email notifications feature to:
- Add an email notification template for a specific locale
- Customize the message contained in the body of the email notification template
- Change the text or branding in an email notification template
- Preview changes to the body of an email notification template
-
Send a test email to see how the email notification will look in various email clients
Example: Outlook, Gmail, Yahoo, and so on
- Save a draft of the email notification template
- Delete an email notification template
This feature consists of the following pages:
- Email Notifications—Use this page to locate and access your email notifications.
- Email Notification—Use this page when you want to view or manage the details of a specific email notification for your site and supported locales. Each email notification contains a set of email notification templates.
-
Email Notification Template—Use this page to manage the templates for specific locales. An email notification template contains the body of an email for a specific locale. You can create a template for each locale and customize the message based on that locale for your site.
Email notifications attributes
The following table lists that attributes that appear on the Email Notifications page.
| Attribute | Description |
|---|---|
| Email Notifications | |
| Email Notification Name |
The name of the email notification for an event. Click the link to view the email notification. See How to edit an email notification for more information on email notifications: Click + next to the email notification name to see the templates associated with the email notification by locale. See the following topics for more information on templates: |
| Enable/Disable Emails | You can enable or disable the email the email notification types you want to send. See How to enable or disable email notifications for more information. |
| Description | The description of the email notification. |
| Status |
The status of the email notification template. The possible statuses are as follows:
Click + next to the email notification name under the Email Notification Name column to view the actions associated with the email notification template. |
| Locale |
The name of the locale. Click + next to the email notification name under the Email Notification Name column to view the actions associated with the email notification template. |
| Type |
The type of data sent in the email body. You can choose one of the following options:
Click + next to the email notification name under the Email Notification Name column to view the actions associated with the email notification template. |
| Last Modified By | The name of the person who last modified the email notification. |
| Last Modified On | The date and time when the email notification was last modified. |
| Action |
Choose one of the following options:
Click + next to the email notification name under the Email Notification Name column to view the actions associated with the email notification template. See Email notifications for more information on notification email and required Test fields. |
Draft—The template is an unpublished draft.
Published—The template is published. The changes are now live on the site.
Published (Edits in progress)—The published template has been modified from its original version. These changes have not been published.Email notifications
The following table describes the email notifications that appear under the Email Notification Name column and list required test fields, if applicable.
| Email Notification Name | Description | Test Fields |
|---|---|---|
| Client Credit Declined | This email is sent to a customer when they choose to pay for an order with client credit, but the client declined the authorization. This email is triggered when the initial response is Pending. Customers who receive a real-time declined will not receive this email. | Not applicable |
| Client Credit Pending Approval | This email is sent to a customer when they choose to pay for an order with client credit and the initial response to the authorization request from the client system is Pending. | Not applicable |
| Confirm Password Reset Email Event | This email notifies the shopper that their password reset was successful. | User ID* |
| Delayed Payment Expired event | This email notifies the shopper when their Wire Transfer payment has not been received within the allocated days. | User ID* Order ID* Payment Transaction ID* |
| Delayed Payment Request More Funds From Shoppers | This email notifies the shopper that the full Wire Transfer payment for their order has not been received. | Not applicable |
| Digital Rights issued Event | This email notifies the recipient that digital rights were issued from the pending digital rights job manager. | Order ID* Line Item ID* |
| Direct Cancellation of part or entire Order event | This email notifies the shopper when all or part of an order is directly cancelled (no involvement with the fulfiller is necessary). | Order ID* |
| Email Link Event | This email sends the shopper a link to the shopper-side page. | Not applicable |
| Fulfiller Accepted Cancel Request event | The shopper receives this email when a fulfiller sends a message indicating that they can accommodate a Cancel Request by actually stopping fulfillment on the items in the request. | Order ID* |
| Line Of Credit Account Approved | This email notifies the shopper when their line of credit is approved. | Not applicable |
| Line Of Credit Account Overdue | This email notifies the shopper when their line of credit is overdue | Not applicable |
| Line Of Credit Account Rejected | This email notifies the shopper when their request for a line of credit is rejected. | Not applicable |
| Line of Credit Single Purchase Order Instructions | This email notifies the shopper when the Line of Credit Single purchase order has been made. (SR 300118256) | Not applicable |
| Line of Credit Single Purchase Order Rejected | This email notifies the shopper when their Line of Credit Single purchase order has been rejected. (SR 300110735) | Not applicable |
| Low Digital Rights Inventory | This email notifies the user when the inventory account is below the threshold. | Product Data ID* Dispenser ID* |
| Low serial number count | This email notifies the client when the umber count is below the threshold. | Product Data ID* Dispenser ID* Type Inventory Count |
| Managed Inventory OOS Alert Notification Event | This email notifies the user when the inventory is out of stock. (SR 300270341) | Not applicable |
| Managed Inventory Threshold Alert Notification Event | This email notifies the user when the inventory threshold for an item has been reached. | Not applicable |
| New Plan User Registration Event | This email notifies the shopper to purchase the a plan and provides the user with an activation link and instructions to activate their account. | Not applicable. |
| Notify Shopper Event | This email notifies the shopper when a product is back in stock and ready to purchase. | Not applicable |
| Override Shopping and Purchase Restrictions Notification Event | This email notifies the shopper provides a shopper with a direct link to the online store. | Not applicable |
| Partner Signup Notify Client | This email notifies a client who signed up as a partner when a new partner is interested in reselling the client's products. | Not applicable |
| Partner Signup Notify Partner | This email notifies a partner when their application has been submitted to a client. | Not applicable |
| PII removal event | This email notifies the shopper that their request to remove their Personally Identifiable Information (PII) has been processed. | Not applicable |
| Pre Order Audit event | This email notifies the client when a preorder for a product occurs. | Site ID* Product Data ID* Number of Pre-orders Number of Pre-orderd quantity Total Available Digital Rights |
| Pre Order Has Been Released event | This email tells the shopper that their preordered product is now available. | Order ID* Line Item ID* |
| Pre Order Missing Application File event | This email tells the user that the application file for the preorder product has not been uploaded. As a result, the release has been put on hold until the application file is added to the product. | Site ID* Product Data ID* |
| Pre Order Preload Product Available event | This email thanks the shopper for preordering the product and provide order details. | Not applicable |
| Pre Oder Price Change event | This email notifies the shopper that there has been a price change on their current purchase and the system will charge a low price for the product. SR 300087372 | Not applicable |
| Pre Order Price Refund event | This email notifies the shopper that there has been a price change on their current purchase. As a result, they will be issued a refund. | Not applicable |
| Pre Order Has Been Cancelled event | This email notifies the shopper that the product they preordered has been cancelled. | Not applicable |
| Pre Order Release Date Has Been Changed event | This email notifies the shopper that the release date for the preordered product has been changed. | Not applicable |
| Product EOL Alert Notification | This email notifies the shopper when a product will expire and reach end of life (EOL). | Not applicable |
| Product EOL Reached Notification | This email notifies the shopper that their product has expired. | Not applicable |
| Product Support Notification event | This email notifies the your customer support when a shopper requires help with a product. | Email From Email Subject Email Message |
| Purchase Plan Reactivation Event | This email notifies the shopper when their purchase plan account requires reactivation. | Not applicable |
| Release Error Order | This email notifies the shopper when their order has been reviewed and is ready to be completed. | Not applicable |
| Reset Order Password Email Event | The shopper receives this email that allows them to change their password when they initiate a password change request. | User ID* |
| Saved Detailed Order Create Event | This email provides the shopper with an estimated price. | Not applicable |
| Saved Order Create Event | This email provides the shopper with an estimated price. | Not applicable |
| Send Delayed 7eShop Payment Reminder event | The 7-11 PIN code payment is a popular Taiwanese payment method. Shoppers who choose this payment method will pay for their purchase at a local 7-11 location. | Not applicable |
| Send Delayed ATM Payment Reminder event | This email sends delayed ATM payment details to the shopper that they can use to pay for their order. | Not applicable |
| Send Delayed bPay Payment Reminder event | This email sends delayed bPay payment details to the shopper that they can use to pay for their order. | Not applicable |
| Send Delayed Direct Debit Payment Reminder | This email sends delayed Direct Debit payment details to the shopper that indicates their payment is being processed. | Not applicable |
| Send Delayed Konbini Payment Reminder event | This email sends delayed Konbini payment details to the shopper that they can use to pay for their order. | Not applicable |
| Send Delayed PayEasy Payment Reminder event | This email sends delayed PayEasy payment details to the shopper that they can use to pay for their order. | Not applicable |
| Send Delayed Payment Reminder event | This email provides the shopper a delayed payment reminder notification for their order when they use Wire Transfer as their payment method. Wire Transfers for customers not located in AT, BE, CH, CY, CZ, DE, DK, EE, ES, FI, FR, GB, GR, IE, IT, LU, LV, MT, NL, NO, PL, PT, RU, SE, SI, SK, and ZA. | Order ID* Payment Transaction Id* |
| Send Delayed Wire Transfer Payment Reminder event | This email provides the shopper a delayed payment reminder notification for their order when they use Wire Transfer as their payment method. Wire Transfers for customers located in AT, BE, CH, CY, CZ, DE, DK, EE, ES, FI, FR, GB, GR, IE, IT, LU, LV, MT, NL, NO, PL, PT, RU, SE, SI, SK, and ZA. | Order ID* Payment Transaction Id* |
| Send Download Instructions Event | This email sends the download instructions to the customer. | Not applicable |
| Send Reminder Email Event | This email sends a reminder email to the customer | Not applicable |
| Send require refund bank information notification event | This email sends the customer to provide information required to receive a refund. | Not applicable |
| Shipping Invalid Product Weight Notification | This email notifies you during the shipping cost calculation when a physical product does not have a weight entered in the product details or a weight of zero (0). | Not applicable |
| Shipping Tier Not Found Notification | This email notifies you during the shipping cost calculation when a shipping tier does not exist in the shipping table. | Not applicable |
| Shopper Contact Customer Service Notification event | This email notifies you that a shopper contacted customer service with a question or request. | Not applicable |
| Suppress Delayed Sales | This email notifies the customer that the order has been suppressed. | Not applicable |
| Suppress Error Order | This email notifies the customer that the order could not be completed. | Not applicable |
| Suppress Error Order - Chargeback | This email notifies the customer that the order could not be processed. | Not applicable |
| Upload File Confirmation | This email notifies you that a file has been uploaded. | Not applicable |
| User Address Create Event | This email notifies a customer that their address has been added to their account. | Not applicable |
| User Address Delete Event | This email notifies a customer that their address has been deleted from their account. | Not applicable |
| User Address Update Event | This email notifies a customer that their address has been updated from their account. | Not applicable |
| User Back Order Notification | This email notifies the customer that one or more items in the order is on backorder. | Not applicable |
| User Bank Transfer Request More Funds event | This email notifies the customer that Digital River received a payment. However, the amount received was less than the requested amount. Digital River requests additional funds to pay for the balance of the order. | Not applicable |
| User Cancellation Request Failed event | This email notifies the customer that their request to cancel items from the order failed, because the items were already shipped. | Not applicable |
| User Delayed Payment Refund Failure Event | This email notifies the customer that their refund request failed. | Not applicable |
| User Forgot Order Password | Deprecated. | Not applicable |
| User Forgot Password | Deprecated. | Not applicable |
| User Free Trial Conversion Notification | This email notifies the customer when their free trial converts to a paid subscription. | Not applicable |
| User License Violation Notification | This email notifies the customer when they violated their license by using their country-based license in another country. | Not applicable |
| User Order Cancellation event | Deprecated. Applies only to Klarna cancellations. | Not applicable |
| User Order Confirmation event | This email provides order confirmation information to the customer after the customer places the order. | Not applicable |
| User Order In Review | This email notifies the customer when an order requires additional processing such as when an order state is Fraud or In Review. | Not applicable |
| User Order Rejection event | Deprecated. | |
| User Payment Details Create event | This email notifies the customer when they chose to save their payment information associated with their account. | Not applicable |
| User Payment Details Payment Details Delete event | This email notifies the customer when they chose to delete their payment information associated with their account. | Not applicable |
| User Payment Details Update event | This email notifies the customer when they chose to update their payment information associated with their account. | Not applicable |
| User Payment Prenotification Event | This email notifies the customer a specified number of business days before their account is debited. It contains the order amount and the date the customer's bank account will be debited. | Not applicable |
| User Profile Update Event | This email notifies the customer when they have made updates to their account. | Not applicable |
| User Quote Reply event | This email notifies the customer when the seller has an updated quote. | Not applicable |
| User Refund Confirmation | This email notifies the customer when the payment processor confirms the refund | Not applicable |
| User Return LOD event | This email notifies the customer when a product return requires a letter of destruction (LOD) and provides instructions accepting the terms and conditions of the LOD. | Not applicable |
| User Return LOD Rejection Event | This email notifies the customer when the return request and letter of destruction (LOD) is rejected. | Not applicable |
| User Return Physical event | This email sends the customer instructions for RMAs When a shopper contacts Customer Service, Customer Service generates an return merchandise authorization (RMA) when they initiate a return. The RMA waits for the return of the ELOD or the physical product. As Customer Service receives the items, they initiate a refund transaction to the shopper. A setting determines how long an individual RMA can exist. The system sends an email to the shopper that includes the expiration date for an RMA when Customer Service initiates the RMA. for non-Catalina returns. |
Not applicable |
| User Return Physical Post External Instruction event | This email notifies the customer that a return has been initiated for the specified physical products. | Not applicable |
| User Return Physical Pre External Instruction event | This email notifies the customer that a return has been initiated for the specified line item products. | Not applicable |
| User Shipment Confirmation | This email notifies the customer that their products have shipped. | Not applicable |
| User Subscription Auto Renewal event | This email notifies the customer that their subscription was automatically renewed. | Not applicable |
| User Subscription Auto Renewal Failure event | This email notifies the customer that the subscription failed to automatically renew due to a payment authorization failure. | Not applicable |
| User Subscription Cancellation Auto Renewal Notification | This email notifies the customer that their auto renewal subscription was cancelled. | Not applicable |
| User Subscription Cancellation Manual Renewal Notification | This email notifies the customer that their manual renewal subscription was cancelled. | Not applicable |
| User Subscription Cancellation Other Notification | This email notifies the customer that their subscription was cancelled. | Not applicable |
| User Subscription Expired Credit Card Event 15 day | This email notifies the customer that their subscription will expire in 15 days. | Not applicable |
| User Subscription Expired Credit Card Event 30 day | This email notifies the customer that their subscription will expire in 30 days. | Not applicable |
| User Subscription Expired Credit Card Event 7 day | This email notifies the customer that their subscription will expire in 157 | Not applicable |
| User Subscription Post Reminder Notification | This email notifies the customer that their subscription has expired. | Not applicable |
| User Subscription Reminder Notification | This email notifies the customer that their subscription will expire in a specified number of days. | Not applicable |
| User Subscription Start Auto Renewal Confirmation Notification | This email notifies the customer that automatic billing for their subscription has started. | Not applicable |
| User Subscription Stop Auto Renewal Confirmation Notification | This email notifies the customer that billing for their subscription has stopped. The subscription will remain active until the specified expiration date. | Not applicable |
| VAT Credit Memo Notification event | This email notifies the customer that they received a VAT credit when a refund is issued from Digital River and explains how to read the signed PDF file. Note that Digital River sends this notification only when VAT is collected. | Not applicable |
| VAT Invoice Notification event |
Important: Do no disable the event rule! This email notifies the customer that they received a VAT invoice from Digital River and explains how to read the signed PDF file. Note that Digital River sends this notification only when VAT is collected. |
Not applicable |
| User FTC Affirmative Consent Notification | This email informs the customer if the current shipping date is 30 days greater than the original promised date. And requests the customers consent to a delay in shipping or a refund payment. See FTC 30-day rule for more information. | Not applicable |
| User FTC Affirmative Consent Notification Report | This email sends a report that lists the unfulfilled orders for which notifications have been sent to comply with the FTC Notification Requirement Rules. See FTC 30-day rule for more information. | Not applicable |
| User FTC Right to Cancel Notification | If the order (that's not in a pre-order state) was not shipped within 30 days, this email informs the customer of their right to cancel their order and explains how. If the customer does not respond, they consent to keep the order open. See FTC 30-day rule for more information. | Not applicable |
| User FTC Right to Cancel Notification Report | This email sends a report that lists the cancelled orders for which notifications have been sent to comply with the FTC Notification Requirement Rules. See FTC 30-day rule for more information. | Not applicable |
* Required
FTC 30-day rule
FTC requires sellers who solicit buyers to order merchandise through the mail, via the Internet, or by phone to have a reasonable basis to expect that the sellers can ship within the advertised time frame, or, if no time frame is specified, within 30 days.
The rule also requires that, when a seller cannot ship within the promised time, the seller must obtain the buyer's consent to a delay in shipping or refund payment for the unshipped merchandise.
Obtaining consent
-
First delay (after the promised date or, if none stated, 30 days after the order)
-
Option 1: Send an email informing the customer of the right to cancel and explain how. If the customer does not respond, they consent to keep the order open.
-
Option 2: Cancel the order.
-
-
Second delay (after a second promised date or, if none stated, 60 days after the order)
-
Option 1: Send an email informing the customer they must call customer service to keep the order open. If the customer does not respond, they consent to cancelling the order.
-
Email notification attributes
The following table lists the attributes that appear on the Email Notification page. This page appears when you click an email notification under the Email Notification Name column.
Email notification template attributes
The following table list the attributes that appear on the Email Notification Template page.
| Attribute | Description |
|---|---|
| Email Template | |
| Email Notification Name |
The name of the email notification for an event. |
| Email Description |
The description of the email notification. |
| Locale |
The name of the locale. |
| Status |
The status of the email notification template. The possible statuses are as follows:
|
| Content |
Shows the status of the template in relation to the global email notification template.
|
| Template Details | |
| Name |
The name of the email notification template for a specific locale. You can create a template for each locale and customize the message based on that locale. |
| Description |
The description of the template. You can update the description to suit your needs. Example: Enter an history event in the Description field. |
| Comments |
Comment regarding this template. |
| Character Set |
Select a character set from the list. Your options are as follows:
|
| Email Content | |
| Sender |
The sender's email address. You can use a variable that points to the correct email address based on locale. Example: <%CS_EMAIL_BY_LOCALE%> |
| Subject |
Enter a short description of the message. You can include variables in the subject field. Example: <%REQ_SITE_NAME%> - Pending Approval (Order #<%REQUISITION_ID%>) |
| Type |
The type of data sent in the email body. You can choose one of the following options:
|
| Email Body |
Enter the text that will appear in the body of the email. |
Email notification macros
The following table describes the macros you can use when creating an email notification template. You can use these macros as needed in the Sender, Subject, and Email Body fields.
| Macro Name | Description |
|---|---|
| BACKORDERED_SUMMARY | Collects all backordered products in a requisition and summarizes them. |
| BACKORDERED_SUMMARY_HTML | Returns the backorder summary in an HTML table with classes applied to elements. |
| BASE_PRODUCTID | Returns the base product ID from the productData. |
| BASE_PRODUCTID_FROM_LINEITEM | Returns the uppermost parent productId for that line item. If the shopper purchases a variation of a product, it shows the productID of the variation's base product. |
| CANCEL_REQUEST_SUMMARY | Returns a collection of cancel requests, and creates a table of each cancel request line item's name and cancelled quantity. |
| CANCEL_REQUEST_SUMMARY_HTML | Shows the Product Information for the cancelled order or unpaid order in tabular format. The information includes the Product SKU, Product Name, Quantity, and Reason for the cancellation. |
| CANCELLED_SUMMARY | Shows the product information for a cancelled or unpaid order. The information includes the Product Name, Quantity, Price, and Reason for the cancellation. |
| CART_URL | Returns the shopping cart URL. |
| CASL_FOOTER | Returns the email footer based on the Canadian anti-spam legislation. |
| CASL_FOOTER_HTML | Returns the HTML version of the email footer based on the Canadian anti-spam legislation. |
| CASL_FOOTER_TEXT | Returns the email footer based on the Canadian anti-spam legislation. |
| CHANGE_PASSWORD_LINK | Shows the link with the query token that allows the user to change their password. This encrypted link contains the user's email address and/or user name. |
| CHANGE_PASSWORD_LINK_TIME_PERIOD | Shows the duration in hours when the change password link will be valid. |
| CHARGING_MERCHANT | Shows the name of the charging merchant as it appears on the credit card statement. |
| COMPANY_CONTACT_NAME | Returns the company's contact name. |
| COMPANY_HOME_PAGE | Returns the company's home page URL. |
| COMPANY_NAME | Returns the company's display name. |
| COMPANY_PHONE_NUMBER | Returns company's phone number. |
| COMPLIANCE_AFFIRM_CANCEL_OPTOUT_LINK | Returns the US FTP 30 day compliance opt-out URL. |
| CONTACT_CS_FROM_EMAIL | Shows the email address that the shopper entered on the Contact Customer Service page or the email address for the billing address if a requisition exists. |
| CREDIT_CARD_EXPIRE_DATE | Shows the credit card expiry date. |
| CS_CUST_SERVICE_URL | Shows the Customer Service URL from site settings. |
| CS_CUST_SERVICE_URL_VIA_USER | Returns the Customer Service URL for the user. |
| CS_EMAIL | Returns the Customer Service email of the site defined in Edit/Service. |
| CS_EMAIL_BY_LOCALE | Returns the Customer Service email for requisition aware notifications. |
| CS_PHONE | Returns the phone number of the site attribute VENDOR_CS_PHONE. Then gets the phone number on the Edit Site Service tab. |
| CS_PHONE_BY_LOCALE | Shows the Customer Service phone number by locale. |
| CS_SAVE_DURATION | Returns the duration of the customer's extended subscription for the Customer Service save offer. |
| CS_SAVE_PERIOD | Returns the timeframe for the Customer Service save offer (day, week, and so on). |
| CUSTOMER_SERVICE | Returns the value of the default customer service URL. Currently: http://www.digitalriver.com/cs/ |
| DATE_TODAY_YEAR | Shows the current year. |
| DELAYED_PAYMENT_EXPIRATION_DATE | Returns the expiration date for a delayed payment method. |
| DELAYED_PMT_INSUFF_FUNDS_DIFF_AMT | Shows the difference amount for the insufficient funds in the delayed payment. |
| ELECTRONIC_FULFILLMENT_SUMMARY | Returns the localized version of electronic fulfillment summary. |
| EMAIL_LINK_FROM_EMAIL | Returns the sender's email address from the email message. |
| EMAIL_LINK_FROM_NAME | Shows the sender's name of the email message. |
| EMAIL_LINK_NOTE | Returns the subject of the email message. |
| EMAIL_LINK_TO_NAME | Shows the recipient's name from the email message. |
| EMAIL_LINK_URL | Returns the URL of the shopper-side page in the email message. |
| EXTERNAL_REQUISITION_ID | Shows the order's external reference ID. |
| FREE_ORDER_DOWNLOAD_PAGE_LINK | Shows the link to the free order download page used for email verified opt-in. |
| FROM_EMAIL | Returns the fromEmail from a notification context. |
| FTC_FIRST_SENTENCE |
Returns the following text : Please see the below notes about the fulfillment date for line items on your order. |
| FULL_URL_TO_RENEWAL_PRODUCT | Renews the Subscription. This macro builds the renewal URL. You can append it behind the Renew Now button or text. |
| GIFT_RECIPIENT_NAME | Returns the first and last name from the shipping address for the requisition. The Shipping address maintains the gift recipient's name and address. Returns the site attribute value for "GIFT_RECIPIENT" if the shipping address is empty. |
| INSUFFICENT_FUNDS_INSTRUCTIONS_TEXT | Returns a message for underpayment or partial settlement on a requisition. |
| LI_DIGITAL_RIGHTS_TEXT | Shows the modified version of the LINE_ITEM_DIGITAL_RIGHTS. It includes a Digital Rights Header and allows for multiple values with one value per line. |
| LINE_ITEM_DISCOUNT | Returns the line item discount. |
| LINE_ITEM_PRICE | Returns the total line item price. |
| LINE_ITEM_UNIT_PRICE | Returns the unit price of the line item. |
| LINE_OF_CREDIT_DAYS_OVERDUE | Shows the number of days the account is overdue. |
| LINE_OF_CREDIT_ID | Shows the account ID for the line of credit. |
| LINE_OF_CREDIT_LIMIT | Shows the credit limit for the account. |
| LINE_OF_CREDIT_OVERDUE_DEBITS | Shows the list of overdue debits. |
| LINEITEM_FEE_HELP_URL | Returns the value of the URL of the page that provides required legal information regarding fees on the site. |
| LINEITEM_FEE_WEEE_REG_NBR | Returns a comma-separated list of WEE registration numbers. |
| MESSAGE | Shows all messages from a collection of JobLogs. |
| MESSAGE_TEXT | Shows a message text. |
| NON_US_CURRENCY_NOTE | Returns a currency note for non-USD. |
| OPT_IN_STATUS | Shows the email opt-in status for the user. |
| ORDER_LOOKUP_URL | Shows the value from the STE attribute "FINDMYORDER_URL". To check or review the order, the macro provides the URL to the user/shopper. The macro shows this URL by present ORDER_LOOKUP_URL, which pulls the URL value from STE attribute "FINDMYORDER_URL". |
| PASSWORD_BASED_ON_ORDER |
This macro provides:
|
| PAYMENT_ACCOUNT_HOLDER | Shows the account holder's name. |
| PAYMENT_ACCT_NUMBER_DTLS | Shows the sort code of the bank account. |
| PAYMENT_BANK_NAME | Shows the merchant bank's name. |
| PAYMENT_INSTRUCTIONS_SUMMARY_I18N | Returns the payment instructions summary. |
| PAYMENT_MERCHANT_CITY | Shows the charging merchant's city. |
| PAYMENT_RECEIVED_AMOUNTPAYMENT_RECEIVED_AMOUNT | Shows the received payment amount. |
| PAYMENT_RECEIVED_DATE | Shows the payment received date. |
| PAYMENT_REFERENCE_CODE | Returns the payment reference code. |
| PAYMENT_SWIFT_CODE | Shows the swift code for the bank account. |
| PMT_AUTH_PURCHASE_DEPT | Shows the payment transaction company. |
| PMT_AUTHORIZATION_CODE | Returns the string representation of the authorization code. |
| PMT_BANK_REFUND_LINK | Returns a URL from the CPG used to determine if the refund needs additional bank information. |
| PMT_INSTALLMENT_PLAN | Returns the payment installment plan for Brazil. |
| PMT_INSTALLMENT_TERM | Returns the payment installment term for Brazil. |
| PMT_KLARNA_MESSAGE | Shows the Klarna payment method message, as shown in the shopper's order confirmation email. |
| PMT_PAYMENT_METHOD_NAME | Shows the name of the payment transaction method the shopper used when placing an order. |
| PMT_REDIRECT_URL | Returns the URL to complete payment in case of delayed payment events. |
| PMT_RMA_ID | Returns the reference number or merchandise authorization number for the return. |
| PMT_SECURITY_INDICATOR | Returns the customer payment reference number. |
| PMT_SPECIAL_ID | Returns the biller ID. |
| PMT_WT_IBAN | Prints the International Bank Account number for the wire transfer payment method. |
| PRE_ORDER__PRICE_ADJUSTMENT | Returns the preorder price adjustment. |
| PRE_ORDER_RELEASE_DATE | Shows the release date for pre-ordered products. |
| PROD_DETAIL_PAGE_URL | Returns a URL that redirects a shopper to the Product Details page. |
| PROD_NAME_SKU | Shows the product SKU. |
| PROD_SHORT_DESCRIPTION | Returns the product's short description from the catalog. |
| PRODUCT_DIGITAL_RIGHTS_I18N | Shows the Digital Rights from productData line items. Used for a pre-order release. |
| PRODUCT_EMAIL_ADDL_INFO | Shows additional "email" information for every product in the requisition in the format <Product Display Name> - <additional email text>. If no additional information exists, it shows nothing. |
| PRODUCT_EMAIL_ADDL_INFO_HTML | Shows the Email Additional Product information in HTML format |
| PRODUCT_EMAIL_ADDL_INFO_TEXT | Shows the Additional Product Information saved in the Text-Based Email format. |
| PRODUCT_ID | Returns the Global Commerce product ID. |
| PRODUCT_NAME | Shows the product name. The name is not internationalized. For the locale-specific, internationalized product name see PRODUCT_NAME_I18N. Do not override the implementation to getDisplayName() rather than getName() as has been done in some cases. |
| PRODUCT_NAME_FROM_LINE_ITEM | Returns the product name from the line item in context. |
| PRODUCT_NAME_I18N | Shows the internationalized product name. |
| PRODUCT_PRICE | Returns the product price. |
| PRODUCT_SKU | Returns the product SKU. |
| PURCHASE_PLAN_ACCESS_URL | Returns the URL to access the purchase plan. |
| PURCHASE_PLAN_DISPLAY_NAME | Returns the display name of the Private Store. |
| PURCHASE_PLAN_NEW_USER_ACTIVATION_URL | Returns the Private Store's URL. |
| PURCHASE_PLAN_NEW_USER_INSTRUCTION_EMAIL | Returns the instruction text for the Private Store. |
| PURCHASE_PLAN_NEW_USER_INSTRUCTION_IP_ADDRESS | Returns the Private Store's IP address for the new user. |
| PURCHASE_PLAN_NEW_USER_INSTRUCTION_REFERRAL_URL | Returns the activation link for the Private Store. |
| PURCHASE_PLAN_REGISTRATION_MARKET_NAME | Returns the purchase plan registration market name. |
| QUOTE_QUOTE_ID | Shows the quotation ID when shopper requests a quote. |
| REPLACEMENT_ORDER_ID | Returns the requisition ID for a replacement order. |
| REQ_ARM_SERIAL_NUMBER | Returns an order serial number that will be included in CSR Armadillo License Delivery Notification. |
| REQ_BILLING_ADDRESS | Returns the billing address on the requisition. |
| REQ_BILLING_ADDRESS_HTML | Returns the HTML version of the billing address on the requisition. |
| REQ_BILLING_ADDRESS_HTML | Returns the HTML version of the billing address on the requisition |
| REQ_BILLTO_CITY | Returns the city name on the requisition's billing address. |
| REQ_BILLTO_COMPANY | Shows the company name from the billing address in the requisition. |
| REQ_BILLTO_COUNTRY | Shows the country from the billing address in the requisition. |
| REQ_BILLTO_COUNTRYNAME | Shows the full localized display name of the billing address country. |
| REQ_BILLTO_CSP | Shows the county, state, or province from the billing address in the requisition. |
| REQ_BILLTO_EMAIL | Shows the email on the billing address in the requisition. |
| REQ_BILLTO_LINE1 | Shows the address line 1 on the billing address in the requisition. |
| REQ_BILLTO_LINE2 | Shows the address line 2 on the billing address in the requisition. |
| REQ_BILLTO_LINE3 | Returns the address line 3 on the billing address in the requisition. |
| REQ_BILLTO_NAME |
Shows the first name (name1) and last name (name2) of the shopper in the email notification. The macro shows the last name (name2) followed by first name (name1) for the following locales:
All other locales show the first name followed by the last name. |
| REQ_BILLTO_NAME1 | Returns the first name on the billing address of the requisition. |
| REQ_BILLTO_NAME2 | Returns the last name on the billing address of the requisition. |
| REQ_BILLTO_PHONE | Shows the phone number on the billing address in the requisition. |
| REQ_BILLTO_POSTALCODE | Returns the postal code on the requisition's billing address. |
| REQ_BILLTO_STATE | Returns the state name on the billing address of the requisition. |
| REQ_BUSINESS_ENTITY | Returns the business entity on the requisition. |
| REQ_COMPANY_NAME | Returns the company's name on the requisition. |
| REQ_CREATION_DATE | Returns a requisition creation date. |
| REQ_CREDIT_CARD | Shows a masked version of the last 4 digits of the credit card number. |
| REQ_CREDIT_CARD_EXPIRE_DATE | Returns the credit card expiration date as mentioned on the requisition. |
| REQ_CREDIT_CARD_NUM | Shows a masked version of the credit card number. |
| REQ_CREDIT_CARD_PAYMENT_METHOD_NAME | Returns the credit card payment method name for the given requisition. |
| REQ_DATE | Digital River deprecated this macro. Please use REQ_DATE_I18N instead. |
| REQ_DATE_FULL | Shows the time along with its time zone. |
| REQ_DATE_I18N | Shows the date when the customer placed the order. |
| REQ_DATE_I18N_OTAWARE | Returns the requisition date from the order taker. |
| REQ_DATE_JP | Returns the requisition date for the Japanese wire transfer. |
| REQ_DEFERRED_PAYMENT_DATE | Returns a message with the deferred payment date. |
| REQ_DSK_DATE_JP | Returns the payment deadline date for a Japanese site. |
| REQ_FEES | Shows the itemized list of fees for an order. |
| REQ_LEGAL_FOOTER_HTML | Shows the Digital River legal footer that includes the Digital River Legal Statement along with hyperlinks to the Privacy Policy, Terms of Sale, and Your California Privacy Rights. |
| REQ_LEGAL_FOOTER_TEXT | Shows the legal footer text on each requisition email. |
| REQ_LEVEL_DISCOUNT | Shows the requisition-level discount. |
| REQ_LEVEL_DISCOUNT_HTML | Returns the HTML version of the requisition-level discount. |
| REQ_LINEITEM_DETAILS | Shows lineItem details and Order Information for the requisition. |
| REQ_LINEITEM_DOWNLOAD_LINKS | Returns the download links for line items if available. |
| REQ_LINEITEM_DOWNLOAD_LINKS_HTML | Returns the HTML version of the download links for line items on a requisition. |
| REQ_LOCALE | Returns the locale on the requisition. |
| REQ_PASSWORD | Shows the requisition password. |
| REQ_PASSWORD_FOR_ANONYMOUS_CHECKOUT | Shows the password for an Anonymous User only. |
| REQ_PMT_EFINANCING_DISCLOSURE | Shows the eFinancing disclosure information for the selected eFinancing term for a requisition. |
| REQ_PMT_EFINANCING_TERM_DESCRIPTION | Returns the selected eFinancing term information for a requisition. |
| REQ_PMT_PAYMENT_METHOD_NAME | Returns the name of the payment method used in the order. |
| REQ_REJECTION_REASON | Returns the message the user typed into the message box. |
| REQ_SHIP_TOTAL | Shows the ship total of a requisition. |
| REQ_SHIPPING_ADDRESS | Shows the shopper's shipping details such as Name, Address Line1, Address Line2, City, State, Postal Code, Phone number, and Email address. These details only appear when you're shipping a physical order. |
| REQ_SHIPPING_ADDRESS_HTML | Shows all the shipping details of the Shopper like Name, Address Line1, Address Line2, City, State, Postal Code, Phone number, and Email address. These details only appear when the order you want to ship is physical. |
| REQ_SHIPTO_COMPANY | Returns the company name on the shipping address of the requisition. |
| REQ_SHIPTO_COUNTRY | Shows the country on the shipping address in the requisition. |
| REQ_SHIPTO_COUNTRYNAME | Returns the fully-localized display name of the shipping address country. |
| REQ_SHIPTO_CSP | Shows the county, state, or province from the shipping address in the requisition. |
| REQ_SHIPTO_EMAIL | Shows the email on the shipping address in the requisition. |
| REQ_SHIPTO_LINE1 | Shows the address line 1 from the shipping address in the requisition. |
| REQ_SHIPTO_LINE2 | Shows the address line 2 from the shipping address in the requisition. |
| REQ_SHIPTO_NAME | Shows name on the shipping address in the requisition. |
| REQ_SHIPTO_PHONE | Shows the phone number from the shipping address in the requisition. |
| REQ_SHOPPER_SERIAL_NUMBER | Shows the order serial number that will be sent to the shopper. |
| REQ_SITE_ID | Returns the requisition site ID. |
| REQ_SITE_ID_OTAWARE | Returns the site ID from the order taker. |
| REQ_SITE_NAME | Shows the site name. If the site name is null, then the macros shows the site ID. The macro pulls the site name from the site settings. Notifications also use this macro in subject lines. |
| REQ_SITE_NAME_OTAWARE | Returns the site name from the order taker. |
| REQ_SITE_URL | Shows the requisition's Site Homepage. |
| REQ_SUB_TOTAL | Shows the requisition subtotal. |
| REQ_SUM_I18N | Returns the requisition summary with discounts. |
| REQ_SUM_I18N_DRM_HTML | Shows the Requisition Summary including, Product Name, Quantity, Price, Discount, and Digital Rights. |
| REQ_SUM_I18N_DRM_HTML_NODISC | Shows the requisition summary including, the product name, quantity, price, and digital rights. There is no discount column. |
| REQ_SUM_I18N_HTML | Shows a HTML-formatted requisition summary with localized discounts. |
| REQ_SUM_I18N_HTML_CLASS | Shows the Requisition Summary International with discounts and classes applied to the invoice table elements. |
| REQ_SUM_I18N_INCL_EXCL_VAT | Shows the requisition summary with line item prices including or excluding VAT depending on the site's VAT configuration. |
| REQ_SUMMARY | Digital River deprecated this macro. Please use REQ_SUM_I18N instead. |
| REQ_SUMMARY_I18N_VAT | Returns the requisition summary in a localized format, including name, quantity, price (with tax labels if inclusive), and digital rights (with SN/UC labels). |
| REQ_SUMMARY_I18N_VAT_HTML | Returns the HTML version of the requisition summary. |
| REQ_SUMMARY_INC_TN_AND_DR | Summarizes the line items in the requisition and includes the shipment tracking numbers and the digital rights information. |
| REQ_SUMMARY_INC_TN_AND_DR_I18N | Returns the requisition summary. |
| REQ_SUMMARY_INC_TN_AND_DR_I18N_HTML | Returns the HTML version of the summary of line items in the requisition and include the shipment tracking numbers and the digital rights information. |
| REQ_SUMMARY_INC_TN_AND_DR_NOTRACK_I18N | Shows the requisition summary with no shipment tracking number. |
| REQ_SUMMARY_INC_TN_AND_DR_NOTRACK_I18N_HTML | Shows the HTML version of the requisition summary with no shipment tracking number. |
| REQ_SUMMARY_INC_TN_AND_DR_OTAWARE | Returns requisition summary for the Shopper Contact Customer Service Notification event from the order taker. |
| REQ_SUMMARY_JP | Returns the requisition summary compatible with Japanese sites. |
| REQ_TAX_AND_SHIPPING | Shows the tax and shipping cost as a single amount. |
| REQ_TAX_TOTAL | Shows the total tax for the requisition. |
| REQ_TOTAL_INCL_EXCL_VAT | Shows the requisition total, including all line item prices. The result value includes, or excludes VAT depending on the site's VAT configuration. (Value does not include shipping costs and fees.) |
| REQ_TRUE_SUB_TOTAL | Returns the sub total of a requisition without the order-level incentives. |
| REQ_USER_EMAIL | Shows the email address of the requisition owner. |
| REQ_USER_FULL_NAME | Returns the user's name. If the first name and last name are empty, it returns the site's attribute value for "NEW_CUSTOMER". |
| REQ_USER_FULL_NAME_OTAWARE | Returns the full user name from the order taker. |
| REQ_USER_ID | Shows the user ID on the requisition. |
| REQUISITION_ID | Shows the Order/Requisition ID in the email. |
| REQUISITION_ID_OTAWARE | Returns the requisition ID from the order taker. |
| REQUISITION_TOTAL | Shows the requisition total. |
| RETURN_AMOUNT | Returns the refund amount from product return. |
| RETURN_ID | Shows the ID for the return/RMA. |
| RETURN_LOD_DUE_DATE | Returns the due date when the shopper must accept or decline a LOD. |
| RETURN_LOD_LINK | Returns the shopper summary URL for accessing the LOD Acceptance page. |
| RETURN_PHYSICAL_DUE_DATE | Shows the due date when the shopper must return the physical product. |
| RETURN_PHYSICAL_PRODUCT_DETAIL | Shows the name, quantity, and return address for each product in a physical return RMA. |
| RETURN_PHYSICAL_PRODUCT_DETAIL_HTML | Returns the HTML version of product details of the returned physical product. |
| RETURN_PHYSICAL_PRODUCT_EXTERNAL_INSTRUCTION_DETAIL | Lists the external return information for a Return Physical PostExternalInstruction event. |
| RETURN_PHYSICAL_PRODUCT_PRE_EXTERNAL_INSTRUCTION_DETAIL | Shows products for the User Return Physical PreExternalInstruction event. |
| RETURN_PHYSICAL_PRODUCT_PRE_EXTERNAL_INSTRUCTION_DETAIL_HTML | Returns the product information for physical products in the return request. |
| RETURN_RMA_TIME_LEFT | Shows the number of return RMA days remaining. |
| SAVED_CART_CONTACT_ME | Shows whether the user agreed to be contacted about the duties and tariff estimates. |
| SAVED_CART_CREATION_DATE | Returns the creation date for a saved cart. |
| SAVED_CART_EXPIRATION_DATE | Returns the expiration date for a saved cart. |
| SAVED_CART_EXPIRATION_DAYS | Returns the cart's expiration date for the site as configured under Site Settings. |
| SAVED_CART_LINK | Shows the link that will redirect the user to their cart where their saved products appear. |
| SAVED_CART_LINK_TO_CHECKOUT | Shows the link that redirects the user to the Checkout page where their saved products appear. |
| SEPA_CREDITOR_ID | Returns the creditor ID according to the SEPA direct debit mandate. |
| SEPA_CREDITOR_NAME_ADDRESS | Returns the name and address of the creditor according to the SEPA direct debit mandate. |
| SEPA_MANDATE_CITY | Returns the city of the debtor according to the SEPA direct debit mandate. |
| SEPA_MANDATE_COUNTRY_NAME | Returns the country name of the debtor according to the SEPA direct debit mandate. |
| SEPA_MANDATE_DATE | Returns the mandate date according to the SEPA direct debit mandate. |
| SEPA_MANDATE_DEBTOR_NAME | Returns the debtor's name as mandated by SEPA. |
| SEPA_MANDATE_ID | Returns the mandate ID of the debtor according to the SEPA direct debit mandate. |
| SEPA_MANDATE_LAST_FOUR_ACCOUNT_NUMBER | Returns the account number of the debtor according to the SEPA direct debit mandate. |
| SEPA_MANDATE_POSTAL_CODE | Returns the postal code of the debtor according to the SEPA direct debit mandate. |
| SEPA_MANDATE_STREET_NAME | Returns the street name of the debtor according to the SEPA direct debit mandate. |
| SEPA_MANDATE_SWIFT_BIC | Returns the swift BIC of the debtor according to the SEPA direct debit mandate. |
| SEPA_PAYMENT_DUE_DATE | Returns the payment due date as mandated by SEPA. |
| SERIAL_NUMBER | Shows the product's serial number. |
| SERIAL_NUMBER_TABLE | Contains tracking URLs for the shipping information keyed off of the shipment notice's line items. |
| SERIAL_NUMBER_TABLE_HTML | Shows the localized HTML implementation of SERIAL_NUMBER_TABLE macro. |
| SHARED_USER_ORDER_PASSWORD |
Returns the order's password but not the user's password. Note: Only use this macro for sites where the same user owns many requisitions (for example, NGOP, reseller stores, call centers). |
| SHIP_SUMMARY | Summarizes the shipment based on the reconciliations. |
| SHIP_SUMMARY_HTML | Shows the HTML implementation of the shipment summary based on the reconciliations. |
| SHIPPING_INFO | Returns shipping information if the product belongs to the physical family. |
| SHIPPING_OPTION_NAME | Returns the shipping option name as it appears on the checkout shipping form. |
| SHOPPER_CS_COMMENTS | Shows the comments that the shopper entered on the Contact Customer Service page. This value may be null. |
| SHOPPER_CS_REASONS | Shows the subjects that the shopper selected from the drop-down lists on the Contact Customer Service page. The shopper can select up to three drop-down items. |
| SIT_SITE_NAME | Shows the site's name |
| SITE_CUST_SERVICE_EMAIL | Returns the customer service email from the site where the order was placed. |
| SITE_DELAYED_PAYMENT_EXPIRATION_PERIOD | Shows the number of expiration days before shopper's order expires. |
| SITE_NAME | Shows the site name. |
| SITE_OPT_IN_PAGE_LINK | Shows the link to the My Account page for a site. |
| SITE_OWNING_COMPANY | Returns the name of the site owning company. |
| SITE_OWNING_COMPANY_NAME | Returns the company's name that owns the site. |
| SLIMPAY_MANDATE_ID | Shows the SlimPay mandate ID. |
| SLIMPAY_PAYMENT_DUE_DATE | Returns the payment due date for SLIM pay payment method. |
| SUB_CHARGE_AMOUNT | Shows the subscription charge amount. |
| SUB_CHARGE_DATE | Shows the date when the subscription's first auto-renewal attempt will occur. |
| SUB_EXPIRY_LINEITEM | This macro has been deprecated. Use the SUB_EXPIRY_SUMMARY instead. |
| SUB_EXPIRY_LINEITEM_HTML | This macro has been deprecated. Use the SUB_EXPIRY_SUMMARY_HTML instead. |
| SUB_EXPIRY_SUMMARY | Shows the summary for the subscription expiration. |
| SUB_EXPIRY_SUMMARY_HTML | Shows the subscription information such as product display name, subscription creation date, and expiration date, renewal price in table form. Only use this macro in forward-looking emails such as reminders. Do not use this macro for completed orders such as the renewal success email. |
| SUB_HISTORY_LIST_URL | Creates a URL that takes the shopper to a Subscription Landing Page. Once authenticated, the user will see their subscription history list page. |
| SUB_INSTALLMENT_SUMMARY | Returns the Brazil Celio installation information. |
| SUB_LAST_4_NUMBERS_IN_PAYMENT_METHOD | Shows the last 4 numbers of the payment method for a subscription. |
| SUB_MANUAL_RENEWAL_URL | Creates a URL that takes the shopper to a Subscription Landing page. Once authenticated, the shopper sees the renewal product in their cart. The shopper completes the checkout process manually to renew their subscription. |
| SUB_NEXT_RENEWAL_QUANTITY | Shows the next renewal quantity for a subscription where an increase or decrease quantity has been performed. |
| SUB_ORIGINAL_DIGITALRIGHT_CONTENT | The macro returns a list of digital rights if Digital River issues a separate list of digital rights from the subscription's original order. If there are no Digital River-issued digital rights, then the macro returns the value of the "SN" extended attribute from the requisition. If the requisition does not have the extended attribute, it returns the value of the "SN" extended attribute from the line item, if it exists. |
| SUB_ORIGINAL_ORDER_DATE | Shows the subscription's original order date. |
| SUB_ORIGINAL_ORDER_ID | Shows the subscription's original order ID. |
| SUB_PAYMENT_METHOD_NAME | Shows the payment method name used to buy a subscription. |
| SUB_PRODUCT_DISPLAYNAME | Shows subscription product's display name. |
| SUB_QUANTITY | Shows the current subscription quantity. |
| SUB_RENEWAL_TOTAL | Returns the total price of an order for subscription renewals formatted for the User Autorenew Subscription Combined Renewal Notification. |
| SUB_STOP_AUTORENEW_URL | Creates a URL that takes the shopper to a Subscription Landing Page. Once authenticated, the shopper sees a confirmation page where they may stop their subscription's auto-renewal. |
| SUB_UPDATE_PAYMENT_DETAILS_URL | Creates a URL that takes the shopper to a Subscription Landing Page. Once authenticated, the shopper sees the Update Billing Option page with the billing option pre-selected. |
| SUB_UPGRADE_PRODUCT_DIRECT_TO_CART_URL | Returns a direct to cart URL that will take the shopper to a pre-populated cart with the highest priority upgrade. Use this macro in notifications when you want to encourage the shopper to upgrade. |
| Subscription Expiry Date | Shows the subscription's expiry date. |
| SUBSCRIPTION_EXPIRATION_DATE | Returns the expiration date of the subscription in MM/DD/YYYY format. |
| SUBSCRIPTION_EXPIRATION_DAYS | Shows the number of days before expiration. |
| SUBSCRIPTION_RENEWAL_DATE | Returns the subscription renewal date with a format based on user/site. |
| TECHNICAL_SUPPORT_EMAIL | Shows the Technical Support email address. |
| TECHNICAL_SUPPORT_URL | Returns the Technical Support URL for the site defined in the Edit/Service tab. |
| TIME | Returns the formatted time string. |
| TOTAL_YOU_SAVE | Shows returns the total savings on the requisition. |
| TRACKING_NUMBER | Returns the tracking number. It does not include the tracking URL. If a carrier name is available, it appears in parenthesis. If the fulfiller fills one tracking number per shipment notice, this will work. Otherwise, nothing shows. |
| TRACKING_URL | Returns the tracking URL for the entire shipment notice when the fulfiller fills a tracking number for the entire shipment notice. This macro does not support a tracking number for each line item in the shipment notice. |
| TRACKING_URL_HTML | Returns the tracking URLs. It can handle multiple tracking numbers assuming you delimit each URL with a comma (,). |
| UNFULFILLEDORDER_ESTIMATED_SHIP_BY_DATE | Returns the estimated shipping date for an unfulfilled order. |
| UNFULFILLEDORDER_LINEITEMS_TABLE_HTML | Returns the HTML version of line-item details on a requisition of an unfulfilled order for an unfulfilled order notification event. |
| UNFULFILLEDORDER_REQUISITIONID | Returns the unfulfilled requisition ID that requires notification through the FTC feature. |
| USER_CONTACTUS_URL | Shows the URL that redirects the shopper to the Contact Us page when the user does not reset their password. |
| USER_EMAIL | Shows the user's email address. |
| USER_FIRST_NAME | Shows the user's first name. |
| USER_FULL_NAME | Returns the customer's name. |
| USER_ID | Returns the primary key (user_id) of a user. |
| USER_LAST_NAME | Returns the last name of the shopper. |
| USER_LOGIN_ID | Shows the user's Login ID. |
| USER_PASSWORD | Returns a non-encrypted user password. |
| USER_SITE_NAME | Returns the site's name. |
| VCM_RETURN_AMOUNT | Shows the VAT credit memo return amount. |
| WIRE_TRANSFER_BANK_DETAILS | Produces Wire Transfer bank details for the payment instruction. |
| WIRE_TRANSFER_BANK_DETAILS_HTML | Returns the HTML version of the wire transfer bank details for the payment instruction. |
Required Role: Email Notification Manager
- If your company has more than one site, select the site you want to search from the Site list.
- Select Administration and then click Email Notifications. The Email Notifications page appears.
- Complete the Email Notification Name field under the Search and Filters tab and then click Search
. The results appear in the Email Notifications list.
How to enable or disable email notifications
Required Role: Email Notification Manager
-
Search for the email notification you want to modify. See How to search for an email notification or email notification template for instructions.
-
To enable or disable email notifications, click the Enable/Disable Emails button. The Enable/Disable Emails dialog appears.
-
Choose one of the following options to locate the email you want to enable or disable:
-
Use the search filter.
-
Scroll through Search Results or Selected Items
-
-
Choose one of the following options to enable or disable email.
-
To enable all email, click Select All.
-
To disable all email, click Clear All.
-
To enable one or more email, click + next to each email you want to enable.
-
To disable one or more email, click X next to each email you want to disable.
-
-
Click Apply to save your changes.
How to
Required Role: Email Notification Manager
- Search for the email notification you want to modify. See How to search for an email notification or email notification template for instructions.
- To
- Click Edit.
-
Choose one or more of the following options:
- Add a template. See How to add a template for instructions.
- Edit a template. See How to edit a template for instructions.
- View the template details. See How to preview the template details for instructions.
- Test a template. See How to test the email notification for instructions.
- Click Save.
How to
Required Role: Email Notification Manager
Important: You can only add a template for a locale if a global template exists.
-
Search for the email notification where you want to add a template. See How to search for an email notification or email notification template for instructions.
Note: If you select All from the Site list, you will see the following message.
You are currently editing/creating a global event.
- Click the link under the Email Notification Name column to view the email notification. The Email Notification page appears. See Email notification attributes for more information.
- Under Template Details, click Add Template. The Create Email Notification Template appears.
-
Select a locale from the Choose Locale list. This enables the fields under Template Details and Email Content.
- Complete the fields. See Email notification template attributes for more information.
-
Choose one of the following options:
- To create a draft template or save a published template with edits, click Save. The Status changes to Draft or Published (Edits in progress). Save allows you to keep your changes until you are ready to publish the template.
-
To save and publish the template, click Publish. The Live Change Warning dialog appears.
Type your user name as it appears in the Live Change Warning dialog to verify that you want to make the change on your live store and click OK. A message indicates the template published successfully and the Status changes to Published. The changes are now live on the site.
How to
Required Role: Email Notification Manager
- Search for the email notification that contains the template you want to edit. See How to search for an email notification or email notification template for instructions.
- Click
- Under Templates Details, click the link under the Name column for the template you want to edit. The Email Notification Template page appears.
-
Click Edit to enable the fields for editing and display the View Published Version button. For all other states, you can skip this step because the page is already in edit mode.
- Complete the fields. See Email notification template attributesand Email notification macros for more information.
-
Choose one of the following options:
- To save a draft template or a published template with edits, click Save. The Status changes to Draft or Published (Edits in progress). Save allows you to keep your changes until you are ready to publish the template.
-
To save and publish the template, click Publish. The Live Change Warning dialog appears.
Type your user name as it appears in the Live Change Warning dialog to verify that you want to make the change on your live store and click OK. A message indicates the template published successfully and the Status changes to Published. The changes are now live on the site.
How to
Required Role: Email Notification Manager
- Search for the email notification that contains the template you want to preview. See How to search for an email notification or email notification template for instructions.
-
To preview an email notification, choose one of the following options from the Email Notification page:
-
Under the Email Notification Name column, click + to expand the email notification option, and then click Preview.
-
Under the Email Notification Name column, click the link to go to the Email Notification page, then scroll down to Template details and click Preview. See Email notification attributes for more information.
The Text Preview or HTML Preview window appears and shows the email body.
Note: If no templates appear under Template Details, see Currently no templates are attached to this event for instructions.
-
Currently no templates are attached to this event
The following message appears under Template Details on the Email Notification page when there are no templates associated with the email notification.
Currently no templates are attached to this event
To add a template, contact your Digital River Account Team.
See How to add a template for instructions on adding a template.
How to
Required Role: Email Notification Manager
- Search for the email notification that contains the template you want to test. See How to search for an email notification or email notification template for instructions.
-
To test an email notification, choose one of the following options from the Email Notification page:
-
Under the Email Notification Name column, click + to expand the email notification option, and then click Test.
-
Under the Email Notification Name column, click the link to go to the Email Notification page, then scroll down to Template details and click Test. See Email notification attributes for more information.
The Send test email dialog appears.
Depending on the notification you are testing, the input fields can vary (for example, User ID, Order ID, Subscription ID, Line Item ID, Subscription Line Item ID, Site ID, Payment Transaction ID, Product Data ID, Dispenser ID, Type, Inventory Count, and so on).
Note: If no templates appear under Template Details, see Currently no templates are attached to this event for instructions.
-
-
Complete the fields and click Send. The following message will appear at the top of the page.
You will receive a test in your inbox that shows you what the customer will see when they receive this email.
Note: Make sure the macros in the test email display the correct content. If you use the wrong webhook, the macro will appear empty in the test email. If there is a typo in the macro, the full macro name will appear in the test email (for example, <%USER_FUL_TYPO_NAME%>.