Customer Communication Merge Fields: Difference between revisions
From EnablerWiki
Jump to navigationJump to search
Created page with "asdasd" |
No edit summary |
||
| (13 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
This is a listing of available Merge Fields in EEE Customer Communications. | |||
== Customer == | |||
Fields related to Customer - mostly from the Customer record itself. | |||
{|style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #000; padding: 0; text-align:left;" border="1" cellpadding="5" cellspacing="0" | |||
!Merge tag!!Field!!Notes | |||
|- | |||
|<b>{customercode}</b>||Customer Code|| | |||
|- | |||
|<b>{customercategorycode}</b>||Customer Category Code|| | |||
|- | |||
|<b>{loyaltynumber}</b>||Loyalty Number|| | |||
|- | |||
|<b>{branchcode}</b>||Branch Code|| | |||
|- | |||
|<b>{name}</b>||Name|| | |||
|- | |||
|<b>{surname}</b>||Surname|| | |||
|- | |||
|<b>{firstname}</b>||First name|| | |||
|- | |||
|<b>{salutation}</b>||Salutation|| | |||
|- | |||
|<b>{chargeaccount}</b>||Charge Account?|| | |||
|- | |||
|<b>{accountstatus}</b>||Account Status|| | |||
|- | |||
|<b>{address1}</b>||Address 1|| | |||
|- | |||
|<b>{address2}</b>||Address 2|| | |||
|- | |||
|<b>{address3}</b>||Address 3|| | |||
|- | |||
|<b>{address4}</b>||Address 4|| | |||
|- | |||
|<b>{postcode}</b>||Postcode|| | |||
|- | |||
|<b>{state}</b>||State|| | |||
|- | |||
|<b>{suburbwithstate}</b>||Suburb With State||Address 3 + State | |||
|- | |||
|<b>{country}</b>||Country|| | |||
|- | |||
|<b>{delivery1}</b>||Delivery 1||Delivery address 1 | |||
|- | |||
|<b>{delivery2}</b>||Delivery 2||Delivery address 2 | |||
|- | |||
|<b>{delivery3}</b>||Delivery 3||Delivery address 3 | |||
|- | |||
|<b>{delivery4}</b>||Delivery 4||Delivery address 4 | |||
|- | |||
|<b>{deliverypostcode}</b>||Delivery Postcode|| | |||
|- | |||
|<b>{deliverystate}</b>||Delivery State|| | |||
|- | |||
|<b>{email}</b>||Email|| | |||
|- | |||
|<b>{email2}</b>||Email 2|| | |||
|- | |||
|<b>{phone}</b>||Phone|| | |||
|- | |||
|<b>{phone1}</b>||Phone 1|| | |||
|- | |||
|<b>{fax}</b>||Fax|| | |||
|- | |||
|<b>{mobile}</b>||Mobile|| | |||
|- | |||
|<b>{dob}</b>||Date of birth|| | |||
|- | |||
|<b>{demographic1}</b>||Demographic 1|| | |||
|- | |||
|<b>{demographic2}</b>||Demographic 2|| | |||
|- | |||
|<b>{demographic3}</b>||Demographic 3|| | |||
|- | |||
|<b>{demographic4}</b>||Demographic 4|| | |||
|- | |||
|<b>{demographic5}</b>||Demographic 5|| | |||
|- | |||
|<b>{demographic6}</b>||Demographic 6|| | |||
|- | |||
|<b>{demographic7}</b>||Demographic 7|| | |||
|- | |||
|<b>{demographic8}</b>||Demographic 8|| | |||
|- | |||
|<b>{demographic9}</b>||Demographic 9|| | |||
|- | |||
|<b>{demographic10}</b>||Demographic 10|| | |||
|- | |||
|<b>{demographic11}</b>||Demographic 11|| | |||
|- | |||
|<b>{demographic12}</b>||Demographic 12|| | |||
|- | |||
|<b>{demographic13}</b>||Demographic 13|| | |||
|- | |||
|<b>{demographic14}</b>||Demographic 14|| | |||
|- | |||
|<b>{demographic15}</b>||Demographic 15|| | |||
|- | |||
|<b>{demographic16}</b>||Demographic 16|| | |||
|- | |||
|<b>{demographic17}</b>||Demographic 17|| | |||
|- | |||
|<b>{demographic18}</b>||Demographic 18|| | |||
|- | |||
|<b>{demographic19}</b>||Demographic 19|| | |||
|- | |||
|<b>{demographic20}</b>||Demographic 20|| | |||
|- | |||
|<b>{creditlimit}</b>||Credit Limit|| | |||
|- | |||
|<b>{transactionlimit}</b>||Transaction Limit|| | |||
|- | |||
|<b>{datecustomercreated}</b>||DateCustomer Created|| | |||
|- | |||
|<b>{contact}</b>||Contact|| | |||
|- | |||
|<b>{preferences}</b>||Preferences|| | |||
|- | |||
|<b>{rebatepercentage}</b>||Rebate Percentage|| | |||
|- | |||
|<b>{subsidiarycustomercategorycode}</b>||Subsidiary Customer Category Code|| | |||
|- | |||
|<b>{mastercustomercode}</b>||Master Customer Code|| | |||
|- | |||
|<b>{abn}</b>||ABN|| | |||
|- | |||
|<b>{gstregistered}</b>||GST Registered?|| | |||
|- | |||
|<b>{repnumber}</b>||Rep Number|| | |||
|- | |||
|<b>{financecontactname}</b>||Finance Contact Name|| | |||
|- | |||
|<b>{buyingcontactname}</b>||Buying Contact Name|| | |||
|- | |||
|<b>{salesrepcode}</b>||Sales Rep Code|| | |||
|- | |||
|<b>{newcreditlimit}</b>||New Credit Limit|| | |||
|- | |||
|<b>{newtransactionlimit}</b>||New Transaction Limit|| | |||
|- | |||
|<b>{gender}</b>||Gender|| | |||
|- | |||
|<b>{loyaltystartdate}</b>||Loyalty Start Date|| | |||
|- | |||
|<b>{loyaltystatus}</b>||Loyalty Status|| | |||
|- | |||
|<b>{customercategory}</b>||Customer Category||Description of the customer's category | |||
|- | |||
|<b>{branch}</b>||Branch||Customer's home branch | |||
|- | |||
|<b>{branchaddress1}</b>||Branch Address 1|| | |||
|- | |||
|<b>{branchaddress2}</b>||Branch Address 2|| | |||
|- | |||
|<b>{branchaddress3}</b>||Branch Address 3|| | |||
|- | |||
|<b>{branchstate}</b>||Branch State|| | |||
|- | |||
|<b>{branchpostcode}</b>||Branch PostCode|| | |||
|- | |||
|<b>{branchphone}</b>||Branch Phone|| | |||
|- | |||
|<b>{branchfax}</b>||Branch Fax|| | |||
|- | |||
|<b>{branchemail}</b>||Branch Email|| | |||
|- | |||
|<b>{branchmanager}</b>||Branch Manager|| | |||
|- | |||
|<b>{household}</b>||Household|| | |||
|- | |||
|<b>{occupation}</b>||Occupation|| | |||
|- | |||
|<b>{shoppingfrequency}</b>||ShoppingFrequency||Name of associated shopping frequency | |||
|- | |||
|<b>{emailverificationguid}</b>||EmailVerificationGUID||Unique identifier that needs to be supplied back when EEE to verify Customer's email address | |||
|- | |||
|<b>{password}</b>||Password||Password saved in EEE. May be hashed if configured | |||
|- | |||
|<b>{customerreferenceid}</b>||Customer Reference Id||A unique identifier for the customer | |||
|} | |||
== Loyalty == | |||
Fields related to Loyalty. | |||
{|style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #000; padding: 0; text-align:left;" border="1" cellpadding="5" cellspacing="0" | |||
!Merge tag!!Field!!Notes | |||
|- | |||
|<b>{loyaltyvalueaccumulatedcurrent}</b>||Loyalty Value Accumulated Current||Current points balance | |||
|- | |||
|<b>{loyaltyvalueissuedtotal}</b>||Loyalty Value Issued Total||Total issued | |||
|- | |||
|<b>{loyaltyvalueissuedlast}</b>||Loyalty Value Issued Last||Last issued | |||
|- | |||
|<b>{loyaltystatement}</b>||Loyalty Statement||Loyalty statement for the criteria supplied when creating the communication | |||
|- | |||
|<b>{loyaltypointbonusdaysbeforedobtocommunicate}</b>||Configured no. of days before the customers DOB to communicate with them|| | |||
|- | |||
|<b>{loyaltypointbonusrewardvalue}</b>||Configured reward value of the birthday reward points|| | |||
|- | |||
|<b>{loyaltypointbonusdaysbeforedobtoissue}</b>||Configured no. of days before the customers DOB to issue the reward points|| | |||
|- | |||
|<b>{loyaltycouponbonusdaysbeforedobtocommunicate}</b>||Configured no. of days before the customers DOB to communicate with them|| | |||
|- | |||
|<b>{loyaltycouponbonusrewardvalue}</b>||Configured reward value of the birthday reward coupon|| | |||
|- | |||
|<b>{loyaltycouponbonusdaysbeforedobtoissue}</b>||Configured no. of days before the customers DOB to issue the reward coupon|| | |||
|- | |||
|<b>{loyaltycouponbonusdaysafterdobtoexpire}</b>||Configured no. of days after the customers DOB to expire the reward coupon|| | |||
|- | |||
|<b>{loyaltycouponbonusdaysafterissuetoexpire}</b>||Configured no. of days after the reward is issued to expire the reward coupon|| | |||
|- | |||
|<b>{totalavailablesingleuseflatdollarcouponvalue}</b>||The total $ value of available single use flat dollar promotion coupons available for a customer|| | |||
|- | |||
|<b>{loyaltyspendrequiredforreward}</b>||The amount the customer needs to spend to reach the reward value|| | |||
|- | |||
|<b>{loyaltypointsrequiredforreward}</b>||The amount of points the customer needs to earn to reach the reward value|| | |||
|} | |||
== Customer activity == | |||
Related customer activity known by EEE | |||
{|style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #000; padding: 0; text-align:left;" border="1" cellpadding="5" cellspacing="0" | |||
!Merge tag!!Field!!Notes | |||
|- | |||
|<b>{lastshoppedon}</b>||Last Shopped On||Date last sale was recorded for the customer | |||
|- | |||
|<b>{lastitempurchased}</b>||Last Item Purchased||Description of most recently purchased product | |||
|} | |||
== Voucher Issue == | |||
When the email was triggered by a voucher issue, the following fields are available: | |||
{|style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #000; padding: 0; text-align:left;" border="1" cellpadding="5" cellspacing="0" | |||
!Merge tag!!Field!!Notes | |||
|- | |||
|<b>{amount}</b>||Amount||Amount of the voucher issued | |||
|- | |||
|<b>{expirydate}</b>||ExpiryDate||Expiry date of the voucher | |||
|- | |||
|} | |||
== Customer Orders == | |||
These fields are available when the email was generated as a result of a customer order transaction - e.g. order was created or dispatched. | |||
{|style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #000; padding: 0; text-align:left;" border="1" cellpadding="5" cellspacing="0" | |||
!Merge tag!!Field!!Notes | |||
|- | |||
|<b>{customerorder.ordernumber}</b>||Order Number|| | |||
|- | |||
|<b>{customerorder.branchcode}</b>||Branch Code|| | |||
|- | |||
|<b>{customerorder.branchdescription}</b>||Branch Description (name)|| | |||
|- | |||
|<b>{customerorder.creationdate}</b>||Creation Date|| | |||
|- | |||
|<b>{customerorder.duedate}</b>||Due Date|| | |||
|- | |||
|<b>{customerorder.lastpaymentdate}</b>||Last Payment Date|| | |||
|- | |||
|<b>{customerorder.total}</b>||Total||Total value of the order | |||
|- | |||
|<b>{customerorder.deposit}</b>||Deposit|| | |||
|- | |||
|<b>{customerorder.balance}</b>||Balance|| | |||
|- | |||
|<b>{customerorder.reference1}</b>||Reference1||Transaction number | |||
|- | |||
|<b>{customerorder.status}</b>||Status|| | |||
|- | |||
|<b>{customerorder.deliveryaddress1}</b>||Delivery Address 1|| | |||
|- | |||
|<b>{customerorder.deliveryaddress2}</b>||Delivery Address 2|| | |||
|- | |||
|<b>{customerorder.deliveryaddress3}</b>||Delivery Address 3|| | |||
|- | |||
|<b>{customerorder.deliveryaddress4}</b>||Delivery Address 4|| | |||
|- | |||
|<b>{customerorder.phone1}</b>||Phone 1|| | |||
|- | |||
|<b>{customerorder.phone2}</b>||Phone 2|| | |||
|- | |||
|<b>{customerorder.deliverystate}</b>||Delivery State|| | |||
|- | |||
|<b>{customerorder.deliverycountry}</b>||Delivery Country|| | |||
|- | |||
|<b>{customerorder.deliverypostcode}</b>||Delivery PostCode|| | |||
|- | |||
|<b>{customerorder.instruction1}</b>||Instruction 1|| | |||
|- | |||
|<b>{customerorder.instruction2}</b>||Instruction 2|| | |||
|- | |||
|<b>{customerorder.deliveryname}</b>||Delivery Name|| | |||
|- | |||
|<b>{customerorder.customerorderreference}</b>||Customer Order Reference|| | |||
|- | |||
|<b>{customerorder.invoicenum}</b>||InvoiceNum||Invoice number | |||
|- | |||
|<b>{customerorder.deliverydate}</b>||Delivery Date|| | |||
|- | |||
|<b>{customerorder.pickupbranch}</b>||Pickup Branch|| | |||
|- | |||
|<b>{customerorder.pickupbranchdescription}</b>||Pickup Branch Description|| | |||
|- | |||
|<b>{customerorder.deliverytime}</b>||Delivery Time|| | |||
|- | |||
|<b>{customerorder.freetext1}</b>||Freetext 1|| | |||
|- | |||
|<b>{customerorder.freetext2}</b>||Freetext 2|| | |||
|- | |||
|<b>{customerorder.freetext3}</b>||Freetext 3|| | |||
|- | |||
|<b>{customerorder.freetext4}</b>||Freetext 4|| | |||
|- | |||
|<b>{customerorder.freetext5}</b>||Freetext 5|| | |||
|- | |||
|<b>{customerorder.freetext6}</b>||Freetext 6|| | |||
|- | |||
|<b>{customerorder.freetext7}</b>||Freetext 7|| | |||
|- | |||
|<b>{customerorder.freetext8}</b>||Freetext 8|| | |||
|- | |||
|<b>{customerorder.deliveryemail}</b>||Delivery Email|| | |||
|- | |||
|<b>{customerorder.deliverycompanyname}</b>||Delivery Company Name|| | |||
|- | |||
|<b>{customerorder.shippingprovidername}</b>||Shipping Provider Name|| | |||
|- | |||
|<b>{customerorder.orderdetail}</b>||Order Detail||Renders a HTML table of the items in the order that can be styled using CSS | |||
|- | |||
|<b>{customerorder.orderdetailwithimages}</b>||Order Detail With Images||Renders a HTML table of the items in the order that can be styled using CSS, including embedded images | |||
|- | |||
|<b>{customerorder.paymentmethod}</b>||Payment Method|| | |||
|- | |||
|<b>{customerorder.consignmentreference}</b>||Consignment Reference|| | |||
|- | |||
|<b>{customerorder.consignmentshippingprovider}</b>||Consignment Shipping Provider|| | |||
|- | |||
|<b>{customerorder.consignmenttrackingurl}</b>||Consignment Tracking URL|| | |||
|- | |||
|<b>{customerorder.billingname}</b>||Billing Name|| | |||
|- | |||
|<b>{customerorder.billingcompanyname}</b>||Billing Company Name|| | |||
|- | |||
|<b>{customerorder.billingaddress1}</b>||Billing Address 1|| | |||
|- | |||
|<b>{customerorder.billingaddress2}</b>||Billing Address 2|| | |||
|- | |||
|<b>{customerorder.billingaddress3}</b>||Billing Address 3|| | |||
|- | |||
|<b>{customerorder.billingaddress4}</b>||Billing Address 4|| | |||
|- | |||
|<b>{customerorder.billingpostcode}</b>||Billing PostCode|| | |||
|- | |||
|<b>{customerorder.billingstate}</b>||Billing State|| | |||
|- | |||
|<b>{customerorder.billingcountry}</b>||Billing Country|| | |||
|- | |||
|<b>{customerorder.billingphone1}</b>||Billing Phone1|| | |||
|- | |||
|<b>{customerorder.giftcardactivationcode}</b>||Gift Card Activation Code||Activation code for the gift card that was issued as part of the order | |||
|} | |||
== e-Gift cards == | |||
These fields are available when the email was generated as an e-gift card issued by EEE | |||
{|style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #000; padding: 0; text-align:left;" border="1" cellpadding="5" cellspacing="0" | |||
!Merge tag!!Field!!Notes | |||
|- | |||
|<b>{customerorder.egiftcardfromname}</b>||From Name||Name of customer who purchased the card, as supplied to EEE | |||
|- | |||
|<b>{customerorder.egiftcardtoname}</b>||To Name||Name of intended recipient of the card, as supplied to EEE | |||
|- | |||
|<b>{customerorder.egiftcardtoemail}</b>||To Email||E-mail address of the intended recipient | |||
|- | |||
|<b>{customerorder.egiftcardmessage}</b>||Message||Message supplied to be used with the card issue | |||
|- | |||
|<b>{customerorder.egiftcardimagesource}</b>||Image data||An image for the gift card as a Data URI (base 64) | |||
|- | |||
|<b>{customerorder.egiftcardnumber}</b>||Gift card number|| | |||
|- | |||
|<b>{customerorder.egiftcardnumberasbarcode}</b>||Number as Barcode||Will be rendered as a barcode image in the email | |||
|- | |||
|<b>{customerorder.egiftcardpin}</b>||Pin|| | |||
|- | |||
|<b>{customerorder.egiftcardexpiry}</b>||Expiry||Expiry date of card | |||
|- | |||
|<b>{customerorder.egiftcardvalue}</b>||Value||Value of card | |||
|- | |||
|<b>{customerorder.egiftcardimageurl}</b>||Image URL||URL for the gift card image | |||
|} | |||
== e-Receipts == | |||
Available for e-receipt emails generated by EEE | |||
{|style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #000; padding: 0; text-align:left;" border="1" cellpadding="5" cellspacing="0" | |||
!Merge tag!!Field!!Notes | |||
|- | |||
|<b>{transaction.branchcode}</b>||Transaction Branch Code|| | |||
|- | |||
|<b>{transaction.branchname}</b>||Transaction Branch Name|| | |||
|- | |||
|<b>{transaction.date}</b>||Transaction Date|| | |||
|- | |||
|<b>{transaction.invoicenum}</b>||Transaction Invoice number|| | |||
|} | |||
== Product enquiry == | |||
Available when the email was generated as a part of a customer product enquiry. | |||
{|style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #000; padding: 0; text-align:left;" border="1" cellpadding="5" cellspacing="0" | |||
!Merge tag!!Field!!Notes | |||
|- | |||
|<b>{customerproductenquiry.productcode}</b>||Product Code|| | |||
|- | |||
|<b>{customerproductenquiry.productdescription}</b>||Product Description|| | |||
|- | |||
|<b>{customerproductenquiry.producturl}</b>||Product URL (on website)|| | |||
|- | |||
|<b>{customerproductenquiry.productimageurl}</b>||Product Image URL|| | |||
|- | |||
|<b>{customerproductenquiry.enquirydate}</b>||Enquiry Date|| | |||
|- | |||
|<b>{customerproductenquiry.enquiryfirstname}</b>||Enquiry First Name|| | |||
|- | |||
|<b>{customerproductenquiry.enquirylastname}</b>||Enquiry Last Name|| | |||
|} | |||
== Miscellaneous == | |||
{|style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #000; padding: 0; text-align:left;" border="1" cellpadding="5" cellspacing="0" | |||
!Merge tag!!Field!!Notes | |||
|- | |||
|<b>{ccf_*}</b>||Use the ccf_ prefix to allow Customer Communication Fields retrieved via ufn_GetCustomerCommunicationField|| | |||
|- | |||
|<b>{eeeconfig.*}</b>||Use the eeeconfig. prefix to allow Customer Communication Fields retrieved from Configuration|| | |||
|- | |||
|<b>{webreferenceid}</b>||Web Reference ID||A unique identifier of the email | |||
|- | |||
|<b>{communicationid}</b>||Communication ID||A numeric ID of the email | |||
|} | |||
Latest revision as of 21:54, 22 July 2018
This is a listing of available Merge Fields in EEE Customer Communications.
Customer
Fields related to Customer - mostly from the Customer record itself.
| Merge tag | Field | Notes |
|---|---|---|
| {customercode} | Customer Code | |
| {customercategorycode} | Customer Category Code | |
| {loyaltynumber} | Loyalty Number | |
| {branchcode} | Branch Code | |
| {name} | Name | |
| {surname} | Surname | |
| {firstname} | First name | |
| {salutation} | Salutation | |
| {chargeaccount} | Charge Account? | |
| {accountstatus} | Account Status | |
| {address1} | Address 1 | |
| {address2} | Address 2 | |
| {address3} | Address 3 | |
| {address4} | Address 4 | |
| {postcode} | Postcode | |
| {state} | State | |
| {suburbwithstate} | Suburb With State | Address 3 + State |
| {country} | Country | |
| {delivery1} | Delivery 1 | Delivery address 1 |
| {delivery2} | Delivery 2 | Delivery address 2 |
| {delivery3} | Delivery 3 | Delivery address 3 |
| {delivery4} | Delivery 4 | Delivery address 4 |
| {deliverypostcode} | Delivery Postcode | |
| {deliverystate} | Delivery State | |
| {email} | ||
| {email2} | Email 2 | |
| {phone} | Phone | |
| {phone1} | Phone 1 | |
| {fax} | Fax | |
| {mobile} | Mobile | |
| {dob} | Date of birth | |
| {demographic1} | Demographic 1 | |
| {demographic2} | Demographic 2 | |
| {demographic3} | Demographic 3 | |
| {demographic4} | Demographic 4 | |
| {demographic5} | Demographic 5 | |
| {demographic6} | Demographic 6 | |
| {demographic7} | Demographic 7 | |
| {demographic8} | Demographic 8 | |
| {demographic9} | Demographic 9 | |
| {demographic10} | Demographic 10 | |
| {demographic11} | Demographic 11 | |
| {demographic12} | Demographic 12 | |
| {demographic13} | Demographic 13 | |
| {demographic14} | Demographic 14 | |
| {demographic15} | Demographic 15 | |
| {demographic16} | Demographic 16 | |
| {demographic17} | Demographic 17 | |
| {demographic18} | Demographic 18 | |
| {demographic19} | Demographic 19 | |
| {demographic20} | Demographic 20 | |
| {creditlimit} | Credit Limit | |
| {transactionlimit} | Transaction Limit | |
| {datecustomercreated} | DateCustomer Created | |
| {contact} | Contact | |
| {preferences} | Preferences | |
| {rebatepercentage} | Rebate Percentage | |
| {subsidiarycustomercategorycode} | Subsidiary Customer Category Code | |
| {mastercustomercode} | Master Customer Code | |
| {abn} | ABN | |
| {gstregistered} | GST Registered? | |
| {repnumber} | Rep Number | |
| {financecontactname} | Finance Contact Name | |
| {buyingcontactname} | Buying Contact Name | |
| {salesrepcode} | Sales Rep Code | |
| {newcreditlimit} | New Credit Limit | |
| {newtransactionlimit} | New Transaction Limit | |
| {gender} | Gender | |
| {loyaltystartdate} | Loyalty Start Date | |
| {loyaltystatus} | Loyalty Status | |
| {customercategory} | Customer Category | Description of the customer's category |
| {branch} | Branch | Customer's home branch |
| {branchaddress1} | Branch Address 1 | |
| {branchaddress2} | Branch Address 2 | |
| {branchaddress3} | Branch Address 3 | |
| {branchstate} | Branch State | |
| {branchpostcode} | Branch PostCode | |
| {branchphone} | Branch Phone | |
| {branchfax} | Branch Fax | |
| {branchemail} | Branch Email | |
| {branchmanager} | Branch Manager | |
| {household} | Household | |
| {occupation} | Occupation | |
| {shoppingfrequency} | ShoppingFrequency | Name of associated shopping frequency |
| {emailverificationguid} | EmailVerificationGUID | Unique identifier that needs to be supplied back when EEE to verify Customer's email address |
| {password} | Password | Password saved in EEE. May be hashed if configured |
| {customerreferenceid} | Customer Reference Id | A unique identifier for the customer |
Loyalty
Fields related to Loyalty.
| Merge tag | Field | Notes |
|---|---|---|
| {loyaltyvalueaccumulatedcurrent} | Loyalty Value Accumulated Current | Current points balance |
| {loyaltyvalueissuedtotal} | Loyalty Value Issued Total | Total issued |
| {loyaltyvalueissuedlast} | Loyalty Value Issued Last | Last issued |
| {loyaltystatement} | Loyalty Statement | Loyalty statement for the criteria supplied when creating the communication |
| {loyaltypointbonusdaysbeforedobtocommunicate} | Configured no. of days before the customers DOB to communicate with them | |
| {loyaltypointbonusrewardvalue} | Configured reward value of the birthday reward points | |
| {loyaltypointbonusdaysbeforedobtoissue} | Configured no. of days before the customers DOB to issue the reward points | |
| {loyaltycouponbonusdaysbeforedobtocommunicate} | Configured no. of days before the customers DOB to communicate with them | |
| {loyaltycouponbonusrewardvalue} | Configured reward value of the birthday reward coupon | |
| {loyaltycouponbonusdaysbeforedobtoissue} | Configured no. of days before the customers DOB to issue the reward coupon | |
| {loyaltycouponbonusdaysafterdobtoexpire} | Configured no. of days after the customers DOB to expire the reward coupon | |
| {loyaltycouponbonusdaysafterissuetoexpire} | Configured no. of days after the reward is issued to expire the reward coupon | |
| {totalavailablesingleuseflatdollarcouponvalue} | The total $ value of available single use flat dollar promotion coupons available for a customer | |
| {loyaltyspendrequiredforreward} | The amount the customer needs to spend to reach the reward value | |
| {loyaltypointsrequiredforreward} | The amount of points the customer needs to earn to reach the reward value |
Customer activity
Related customer activity known by EEE
| Merge tag | Field | Notes |
|---|---|---|
| {lastshoppedon} | Last Shopped On | Date last sale was recorded for the customer |
| {lastitempurchased} | Last Item Purchased | Description of most recently purchased product |
Voucher Issue
When the email was triggered by a voucher issue, the following fields are available:
| Merge tag | Field | Notes |
|---|---|---|
| {amount} | Amount | Amount of the voucher issued |
| {expirydate} | ExpiryDate | Expiry date of the voucher |
Customer Orders
These fields are available when the email was generated as a result of a customer order transaction - e.g. order was created or dispatched.
| Merge tag | Field | Notes |
|---|---|---|
| {customerorder.ordernumber} | Order Number | |
| {customerorder.branchcode} | Branch Code | |
| {customerorder.branchdescription} | Branch Description (name) | |
| {customerorder.creationdate} | Creation Date | |
| {customerorder.duedate} | Due Date | |
| {customerorder.lastpaymentdate} | Last Payment Date | |
| {customerorder.total} | Total | Total value of the order |
| {customerorder.deposit} | Deposit | |
| {customerorder.balance} | Balance | |
| {customerorder.reference1} | Reference1 | Transaction number |
| {customerorder.status} | Status | |
| {customerorder.deliveryaddress1} | Delivery Address 1 | |
| {customerorder.deliveryaddress2} | Delivery Address 2 | |
| {customerorder.deliveryaddress3} | Delivery Address 3 | |
| {customerorder.deliveryaddress4} | Delivery Address 4 | |
| {customerorder.phone1} | Phone 1 | |
| {customerorder.phone2} | Phone 2 | |
| {customerorder.deliverystate} | Delivery State | |
| {customerorder.deliverycountry} | Delivery Country | |
| {customerorder.deliverypostcode} | Delivery PostCode | |
| {customerorder.instruction1} | Instruction 1 | |
| {customerorder.instruction2} | Instruction 2 | |
| {customerorder.deliveryname} | Delivery Name | |
| {customerorder.customerorderreference} | Customer Order Reference | |
| {customerorder.invoicenum} | InvoiceNum | Invoice number |
| {customerorder.deliverydate} | Delivery Date | |
| {customerorder.pickupbranch} | Pickup Branch | |
| {customerorder.pickupbranchdescription} | Pickup Branch Description | |
| {customerorder.deliverytime} | Delivery Time | |
| {customerorder.freetext1} | Freetext 1 | |
| {customerorder.freetext2} | Freetext 2 | |
| {customerorder.freetext3} | Freetext 3 | |
| {customerorder.freetext4} | Freetext 4 | |
| {customerorder.freetext5} | Freetext 5 | |
| {customerorder.freetext6} | Freetext 6 | |
| {customerorder.freetext7} | Freetext 7 | |
| {customerorder.freetext8} | Freetext 8 | |
| {customerorder.deliveryemail} | Delivery Email | |
| {customerorder.deliverycompanyname} | Delivery Company Name | |
| {customerorder.shippingprovidername} | Shipping Provider Name | |
| {customerorder.orderdetail} | Order Detail | Renders a HTML table of the items in the order that can be styled using CSS |
| {customerorder.orderdetailwithimages} | Order Detail With Images | Renders a HTML table of the items in the order that can be styled using CSS, including embedded images |
| {customerorder.paymentmethod} | Payment Method | |
| {customerorder.consignmentreference} | Consignment Reference | |
| {customerorder.consignmentshippingprovider} | Consignment Shipping Provider | |
| {customerorder.consignmenttrackingurl} | Consignment Tracking URL | |
| {customerorder.billingname} | Billing Name | |
| {customerorder.billingcompanyname} | Billing Company Name | |
| {customerorder.billingaddress1} | Billing Address 1 | |
| {customerorder.billingaddress2} | Billing Address 2 | |
| {customerorder.billingaddress3} | Billing Address 3 | |
| {customerorder.billingaddress4} | Billing Address 4 | |
| {customerorder.billingpostcode} | Billing PostCode | |
| {customerorder.billingstate} | Billing State | |
| {customerorder.billingcountry} | Billing Country | |
| {customerorder.billingphone1} | Billing Phone1 | |
| {customerorder.giftcardactivationcode} | Gift Card Activation Code | Activation code for the gift card that was issued as part of the order |
e-Gift cards
These fields are available when the email was generated as an e-gift card issued by EEE
| Merge tag | Field | Notes |
|---|---|---|
| {customerorder.egiftcardfromname} | From Name | Name of customer who purchased the card, as supplied to EEE |
| {customerorder.egiftcardtoname} | To Name | Name of intended recipient of the card, as supplied to EEE |
| {customerorder.egiftcardtoemail} | To Email | E-mail address of the intended recipient |
| {customerorder.egiftcardmessage} | Message | Message supplied to be used with the card issue |
| {customerorder.egiftcardimagesource} | Image data | An image for the gift card as a Data URI (base 64) |
| {customerorder.egiftcardnumber} | Gift card number | |
| {customerorder.egiftcardnumberasbarcode} | Number as Barcode | Will be rendered as a barcode image in the email |
| {customerorder.egiftcardpin} | Pin | |
| {customerorder.egiftcardexpiry} | Expiry | Expiry date of card |
| {customerorder.egiftcardvalue} | Value | Value of card |
| {customerorder.egiftcardimageurl} | Image URL | URL for the gift card image |
e-Receipts
Available for e-receipt emails generated by EEE
| Merge tag | Field | Notes |
|---|---|---|
| {transaction.branchcode} | Transaction Branch Code | |
| {transaction.branchname} | Transaction Branch Name | |
| {transaction.date} | Transaction Date | |
| {transaction.invoicenum} | Transaction Invoice number |
Product enquiry
Available when the email was generated as a part of a customer product enquiry.
| Merge tag | Field | Notes |
|---|---|---|
| {customerproductenquiry.productcode} | Product Code | |
| {customerproductenquiry.productdescription} | Product Description | |
| {customerproductenquiry.producturl} | Product URL (on website) | |
| {customerproductenquiry.productimageurl} | Product Image URL | |
| {customerproductenquiry.enquirydate} | Enquiry Date | |
| {customerproductenquiry.enquiryfirstname} | Enquiry First Name | |
| {customerproductenquiry.enquirylastname} | Enquiry Last Name |
Miscellaneous
| Merge tag | Field | Notes |
|---|---|---|
| {ccf_*} | Use the ccf_ prefix to allow Customer Communication Fields retrieved via ufn_GetCustomerCommunicationField | |
| {eeeconfig.*} | Use the eeeconfig. prefix to allow Customer Communication Fields retrieved from Configuration | |
| {webreferenceid} | Web Reference ID | A unique identifier of the email |
| {communicationid} | Communication ID | A numeric ID of the email |