Document Objective
The purpose of this document is to describe the features supported in the standard ESP using Annex Cloud’s Customer Loyalty module.
Supported Modules
- Loyalty
Features Supported on Annex Cloud with Standard ESP
Feature List
-
Feature Name: Create a new customer contact
Description: When a customer enrolls in Annex Cloud Loyalty and does not yet exist in the ESP platform, a new customer contact is created in the ESP platform.
Pre-Requisites:
- The customer must be enrolled in Annex Cloud Loyalty.
- The customer contact must not be present in the ESP platform.
-
Feature Name: Passing of customer loyalty data against a contact
Description: Customer loyalty data will be sent to a customer contact within the ESP platform.
Pre-Requisites:
- The customer's loyalty data must be generated in Annex Cloud Loyalty.
- The customer contact must be present in the ESP platform.
ESP Loyalty Supported Fields
Supported Annex Cloud Loyalty Data Fields for ESP
| Loyalty Fields | Description |
|---|---|
| Loyalty Id | A platform-specific unique identifier for the Loyalty member. |
| First Name | First name of the enrolled member. |
| Last Name | Last name of the enrolled member. |
| Email Address | Email address of the enrolled member. e.g "somebody@who.com" |
| Active Status | If the member has been active on the platform as per the specified duration. |
| Birthday | Member’s birthday date. |
| Loyalty anniversary date | Member’s Loyalty anniversary date. |
| Phone No | Member’s phone number. |
| Zip Code | Member's zip code. |
| Opt-in Status | Member’s loyalty opt-it status. |
| Opt-in Date | Date when the member enrolled in the Loyalty Program. |
| Available Points | Points available for redemption for the member. |
| Earned Points | Total points earned during the duration of the loyalty membership. |
| Used Points | Total points used during the duration of the membership. |
| Hold Points | Members' points that are currently on hold. |
| Next Expiring Points | These points will expire next if not used. |
| Points Expiration Date | This is the date when points earned will expire next if not used. |
| Expired Points | These points are expired because they were not used. |
| Current Tier | Current tier of the member e.g "Gold". |
| Next Tier | Next higher tier based on the current tier. |
| Points Req For Next Tier | Number of points required for the member to reach the next higher tier. |
| Tier Achieve Date | The member's current tier achieve date. |
| Available Rewards |
List of eligible rewards for the member to redeem based on the available points. E.g $5 Reward | $10 Reward | $15 Reward |
| Points Req For Next Reward | The points needed for a member to be eligible for the next higher reward. |
| Highest Available Reward | The highest reward that a member is eligible for . |
| First Loyalty Activity Date | After enrollment when the member performs any loyalty activity for the first time. E.g. activities like making purchases, referring a friend, writing reviews, and other relevant actions may apply. |
| Last Loyalty Activity Date | Date when the last loyalty activity was performed by the member. |
| First Purchase Date | Date when the first purchase activity was performed by the member. |
| Last Purchase Date | Date when the last purchase activity was performed by the member. |
ESP RAF Supported Fields
Below is the list of supported Annex Cloud RAF data fields for the ESP
| Data Fields | Description |
|---|---|
| Referrer_Email | Email address of the referrer. e.g "somebody@who.com". |
| Referrer_fname | First name of the registered user. |
| Referrer_lname | Last Name Of The Register User. |
| Newsletter_status | Newsletter Subscription Status (Yes/No). |
| Share_resource | Social network likes ( FB, Twitter, Email, personal Bitly url). |
| Emailreceiver | Friend Who Receive Email Of Referral (sharing page). |
| Bitlyurl | Shortened Bitly URL that is shared (sharing page). |
| Friend_email | The person with whom referral link is to shared (Unlock page). |
| Friend _name | Get friend name after the purchase referral order. |
| Coupon_code | Friend unlock the coupon code (Unlock Page). |
| Stat id | Option field use in referral register case. |
| Claim rewards url | The URL where the user can see all rewards that can be claim. |
| Invite_code | Unique Invitation Code. |
| Reward_code | Sharer get code from reward claim section. |
| Coupon_Used | coupon code used sale track time. |
| Credits_earned | Sharer total earn credit count. |
FAQ
What is Site ID?
Ans: A unique ID for every e-commerce site to integrate with Annex Cloud.
Glossary
| Terminology | Description |
|---|---|
| ESP | Email Service Provider |
| AC | Annex Cloud |