Customer Communication Merge Fields: Difference between revisions
From EnablerWiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| Line 227: | Line 227: | ||
|- | |- | ||
|<b>{lastitempurchased}</b>||LastItemPurchased||Description of most recently purchased product | |<b>{lastitempurchased}</b>||LastItemPurchased||Description of most recently purchased product | ||
| | |} | ||
== Voucher Issue == | == Voucher Issue == | ||
| Line 399: | Line 400: | ||
|<b>{customerorder.egiftcardvalue}</b>||EGiftCardValue|| | |<b>{customerorder.egiftcardvalue}</b>||EGiftCardValue|| | ||
|- | |- | ||
|<b>{customerorder.egiftcardimageurl}</b>||EGiftCardImageUrl|| | |<b>{customerorder.egiftcardimageurl}</b>||EGiftCardImageUrl||URL for the gift card image | ||
|} | |} | ||
Revision as of 00:44, 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 | Description |
|---|---|---|
| {customercode} | CustomerCode | |
| {customercategorycode} | CustomerCategoryCode | |
| {loyaltynumber} | LoyaltyNumber | |
| {branchcode} | BranchCode | |
| {name} | Name | |
| {surname} | Surname | |
| {firstname} | Firstname | |
| {salutation} | Salutation | |
| {chargeaccount} | ChargeAccount | |
| {accountstatus} | AccountStatus | |
| {address1} | Address1 | |
| {address2} | Address2 | |
| {address3} | Address3 | |
| {address4} | Address4 | |
| {postcode} | Postcode | |
| {state} | State | |
| {suburbwithstate} | SuburbWithState | Address 3 + State |
| {country} | Country | |
| {delivery1} | Delivery1 | Delivery address 1 |
| {delivery2} | Delivery2 | Delivery address 2 |
| {delivery3} | Delivery3 | Delivery address 3 |
| {delivery4} | Delivery4 | Delivery address 4 |
| {deliverypostcode} | DeliveryPostcode | |
| {deliverystate} | DeliveryState | |
| {email} | ||
| {email2} | Email2 | |
| {phone} | Phone | |
| {phone1} | Phone1 | |
| {fax} | Fax | |
| {mobile} | Mobile | |
| {dob} | DOB | |
| {demographic1} | Demographic1 | |
| {demographic2} | Demographic2 | |
| {demographic3} | Demographic3 | |
| {demographic4} | Demographic4 | |
| {demographic5} | Demographic5 | |
| {demographic6} | Demographic6 | |
| {demographic7} | Demographic7 | |
| {demographic8} | Demographic8 | |
| {demographic9} | Demographic9 | |
| {demographic10} | Demographic10 | |
| {demographic11} | Demographic11 | |
| {demographic12} | Demographic12 | |
| {demographic13} | Demographic13 | |
| {demographic14} | Demographic14 | |
| {demographic15} | Demographic15 | |
| {demographic16} | Demographic16 | |
| {demographic17} | Demographic17 | |
| {demographic18} | Demographic18 | |
| {demographic19} | Demographic19 | |
| {demographic20} | Demographic20 | |
| {creditlimit} | CreditLimit | |
| {transactionlimit} | TransactionLimit | |
| {datecustomercreated} | DateCustomerCreated | |
| {contact} | Contact | |
| {preferences} | Preferences | |
| {rebatepercentage} | RebatePercentage | |
| {subsidiarycustomercategorycode} | SubsidiaryCustomerCategoryCode | |
| {mastercustomercode} | MasterCustomerCode | |
| {abn} | ABN | |
| {gstregistered} | GSTRegistered | |
| {repnumber} | RepNumber | |
| {financecontactname} | FinanceContactName | |
| {buyingcontactname} | BuyingContactName | |
| {salesrepcode} | SalesRepCode | |
| {newcreditlimit} | NewCreditLimit | |
| {newtransactionlimit} | NewTransactionLimit | |
| {gender} | Gender | |
| {loyaltystartdate} | LoyaltyStartDate | |
| {loyaltystatus} | LoyaltyStatus | |
| {customercategory} | CustomerCategory | |
| {branch} | Branch | Customer's home branch |
| {branchaddress1} | BranchAddress1 | |
| {branchaddress2} | BranchAddress2 | |
| {branchaddress3} | BranchAddress3 | |
| {branchstate} | BranchState | |
| {branchpostcode} | BranchPostCode | |
| {branchphone} | BranchPhone | |
| {branchfax} | BranchFax | |
| {branchemail} | BranchEmail | |
| {branchmanager} | BranchManager | |
| {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} | CustomerReferenceId | A unique identifier for the customer |
Loyalty
Fields related to Loyalty.
| Merge tag | Field | Description |
|---|---|---|
| {loyaltyvalueaccumulatedcurrent} | LoyaltyValueAccumulatedCurrent | Current points balance |
| {loyaltyvalueissuedtotal} | LoyaltyValueIssuedTotal | Total issued |
| {loyaltyvalueissuedlast} | LoyaltyValueIssuedLast | Last issued |
| {loyaltystatement} | LoyaltyStatement | 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 | Description |
|---|---|---|
| {lastshoppedon} | LastShoppedOn | Date last sale was recorded for the customer |
| {lastitempurchased} | LastItemPurchased | 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 | Description |
|---|---|---|
| {amount} | Amount | Amount of the voucher issued |
| {expirydate} | ExpiryDate | Expiry date of the voucher |
Miscellaneous
| Merge tag | Field | Description |
|---|---|---|
| {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} | WebReferenceId | A unique identifier for the email |
| {communicationid} | CommunicationId | A numeric Id for the email |
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 | Description |
|---|---|---|
| {customerorder.ordernumber} | CustomerOrder.OrderNumber | Order number |
| {customerorder.branchcode} | CustomerOrder.BranchCode | |
| {customerorder.branchdescription} | CustomerOrder.BranchDescription | |
| {customerorder.creationdate} | CustomerOrder.CreationDate | |
| {customerorder.duedate} | CustomerOrder.DueDate | |
| {customerorder.lastpaymentdate} | CustomerOrder.LastPaymentDate | |
| {customerorder.total} | CustomerOrder.Total | |
| {customerorder.deposit} | CustomerOrder.Deposit | |
| {customerorder.balance} | CustomerOrder.Balance | |
| {customerorder.reference1} | CustomerOrder.Reference1 | Transaction number |
| {customerorder.status} | CustomerOrder.Status | |
| {customerorder.deliveryaddress1} | CustomerOrder.DeliveryAddress1 | |
| {customerorder.deliveryaddress2} | CustomerOrder.DeliveryAddress2 | |
| {customerorder.deliveryaddress3} | CustomerOrder.DeliveryAddress3 | |
| {customerorder.deliveryaddress4} | CustomerOrder.DeliveryAddress4 | |
| {customerorder.phone1} | CustomerOrder.Phone1 | |
| {customerorder.phone2} | CustomerOrder.Phone2 | |
| {customerorder.deliverystate} | CustomerOrder.DeliveryState | |
| {customerorder.deliverycountry} | CustomerOrder.DeliveryCountry | |
| {customerorder.deliverypostcode} | CustomerOrder.DeliveryPostCode | |
| {customerorder.instruction1} | CustomerOrder.Instruction1 | |
| {customerorder.instruction2} | CustomerOrder.Instruction2 | |
| {customerorder.deliveryname} | CustomerOrder.DeliveryName | |
| {customerorder.customerorderreference} | CustomerOrder.CustomerOrderReference | |
| {customerorder.invoicenum} | CustomerOrder.InvoiceNum | Invoice number |
| {customerorder.deliverydate} | CustomerOrder.DeliveryDate | |
| {customerorder.pickupbranch} | CustomerOrder.PickupBranch | |
| {customerorder.pickupbranchdescription} | CustomerOrder.PickupBranchDescription | |
| {customerorder.deliverytime} | CustomerOrder.DeliveryTime | |
| {customerorder.freetext1} | CustomerOrder.Freetext1 | |
| {customerorder.freetext2} | CustomerOrder.Freetext2 | |
| {customerorder.freetext3} | CustomerOrder.Freetext3 | |
| {customerorder.freetext4} | CustomerOrder.Freetext4 | |
| {customerorder.freetext5} | CustomerOrder.Freetext5 | |
| {customerorder.freetext6} | CustomerOrder.Freetext6 | |
| {customerorder.freetext7} | CustomerOrder.Freetext7 | |
| {customerorder.freetext8} | CustomerOrder.Freetext8 | |
| {customerorder.deliveryemail} | CustomerOrder.DeliveryEmail | |
| {customerorder.deliverycompanyname} | CustomerOrder.DeliveryCompanyName | |
| {customerorder.shippingprovidername} | CustomerOrder.ShippingProviderName | |
| {customerorder.orderdetail} | CustomerOrder.OrderDetail | Renders a HTML table of the items in the order that can be styled using CSS |
| {customerorder.orderdetailwithimages} | CustomerOrder.OrderDetailWithImages | Renders a HTML table of the items in the order that can be styled using CSS, including embedded images |
| {customerorder.paymentmethod} | CustomerOrder.PaymentMethod | |
| {customerorder.consignmentreference} | CustomerOrder.ConsignmentReference | |
| {customerorder.consignmentshippingprovider} | CustomerOrder.ConsignmentShippingProvider | |
| {customerorder.consignmenttrackingurl} | CustomerOrder.ConsignmentTrackingUrl | |
| {customerorder.billingname} | CustomerOrder.BillingName | |
| {customerorder.billingcompanyname} | CustomerOrder.BillingCompanyName | |
| {customerorder.billingaddress1} | CustomerOrder.BillingAddress1 | |
| {customerorder.billingaddress2} | CustomerOrder.BillingAddress2 | |
| {customerorder.billingaddress3} | CustomerOrder.BillingAddress3 | |
| {customerorder.billingaddress4} | CustomerOrder.BillingAddress4 | |
| {customerorder.billingpostcode} | CustomerOrder.BillingPostCode | |
| {customerorder.billingstate} | CustomerOrder.BillingState | |
| {customerorder.billingcountry} | CustomerOrder.BillingCountry | |
| {customerorder.billingphone1} | CustomerOrder.BillingPhone1 | |
| {customerorder.giftcardactivationcode} | GiftCardActivationCode | 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 | Description |
|---|---|---|
| {customerorder.egiftcardfromname} | EGiftCardFromName | Name of customer who purchased the card, as supplied to EEE |
| {customerorder.egiftcardtoname} | EGiftCardToName | Name of intended recipient of the card, as supplied to EEE |
| {customerorder.egiftcardtoemail} | EGiftCardToEmail | E-mail address of the intended recipient |
| {customerorder.egiftcardmessage} | EGiftCardMessage | Message supplied to be used with the card issue |
| {customerorder.egiftcardimagesource} | EGiftCardImageSource | An image for the gift card as a Data URI (base 64) |
| {customerorder.egiftcardnumber} | EGiftCardNumber | |
| {customerorder.egiftcardnumberasbarcode} | EGiftCardNumberasBarcode | Will be rendered as a barcode image in the email |
| {customerorder.egiftcardpin} | EGiftCardPin | |
| {customerorder.egiftcardexpiry} | EGiftCardExpiry | Expiry date |
| {customerorder.egiftcardvalue} | EGiftCardValue | |
| {customerorder.egiftcardimageurl} | EGiftCardImageUrl | URL for the gift card image |
Product enquiry
Available when the email was generated as a part of a customer product enquiry.
e-Receipts
Available for e-receipt emails generated by EEE
| Merge tag | Field | Description |
|---|---|---|
| {customerproductenquiry.productcode} | CustomerProductEnquiry.ProductCode | |
| {customerproductenquiry.productdescription} | CustomerProductEnquiry.ProductDescription | |
| {customerproductenquiry.producturl} | CustomerProductEnquiry.ProductUrl | |
| {customerproductenquiry.productimageurl} | CustomerProductEnquiry.ProductImageUrl | |
| {customerproductenquiry.enquirydate} | CustomerProductEnquiry.EnquiryDate | |
| {customerproductenquiry.enquiryfirstname} | CustomerProductEnquiry.EnquiryFirstName | |
| {customerproductenquiry.enquirylastname} | CustomerProductEnquiry.EnquiryLastName | |
| {transaction.branchcode} | Transaction Branch Code (eReceipts Only) | |
| {transaction.branchname} | Transaction Branch Name (eReceipts Only) | |
| {transaction.date} | Transaction Date (eReceipts Only) | |
| {transaction.invoicenum} | Transaction Invoice number (eReceipts Only) |
