Customer Communication Merge Fields: Difference between revisions
From EnablerWiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| Line 437: | Line 437: | ||
|<b>{eeeconfig.*}</b>||Use the eeeconfig. prefix to allow Customer Communication Fields retrieved from Configuration|| | |<b>{eeeconfig.*}</b>||Use the eeeconfig. prefix to allow Customer Communication Fields retrieved from Configuration|| | ||
|- | |- | ||
|<b>{webreferenceid}</b>|| | |<b>{webreferenceid}</b>||Web Reference ID||A unique identifier for the email | ||
|- | |- | ||
|<b>{communicationid}</b>||Communication ID||A numeric Id for the email | |<b>{communicationid}</b>||Communication ID||A numeric Id for the email | ||
|} | |} | ||
Revision as of 01:29, 20 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 for the email |
| {communicationid} | Communication ID | A numeric Id for the email |