Objective
The intention of this document is to integrate Annex Cloud products with Listrak ESP so that the Annex Cloud clients can use Listrak ESP for their marketing activities. The data fields can be customized as per the requirements. Send required data from Annex Cloud to corresponding Listrak ESP fields.
Supported Versions
| API Supporting Versions | Certified Versions |
|---|---|
| REST- V1 | NA |
Listrak Supported Feature List
Below is the list of features supported on Listrak using Annex Cloud.
Loyalty
| 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. |
Refer A Friend (RAF)
Below are the supporting data fields that can be utilized for RAF.
| 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. |
Visual Commerce (VC)
| ac_vc_name | Full Name of the registered customer. |
| ac_vc_email | Email address of the registered customer, typically in the format somebody@who.com. |
| ac_vc_product code | Identifier for the product associated with the image. This could be a unique code or reference number for the product. |
| ac_vc_instagram photo url | URL of the photo posted by the customer on Instagram. This URL likely points to an image hosted on Instagram. |
| ac_vc_subscribed | Newsletter Signup status. This field could indicate whether the registered customer has subscribed to a newsletter, typically using values like "Yes" or "No" or binary values like 1 for subscribed and 0 for not subscribed. |
Ratings & Review (R&R)
| Data Fields | Description |
|---|---|
| Date | The date when the review was submitted. |
| Bottom line | A concise summary or conclusion about the product. |
| Comfort | A rating or assessment of the product's comfort level, typically as satisfying or not satisfying. |
| Cons | Negative aspects or drawbacks of the product as mentioned by the reviewer. |
| Email address of the reviewer for contact or verification purposes. | |
| Location | The location (country, city, state) of the reviewer. |
| Nickname | The nickname or name of the reviewer. |
| Overall rating | The overall rating given by the reviewer to the product. |
| Please tell us why | A field for the reviewer to provide additional comments or reasons for their rating, especially if it's very low. |
| Pros | Positive aspects or strengths of the product as mentioned by the reviewer. |
| Quality | Assessment of the product's quality. |
| Recommend Friend | Whether the reviewer would recommend the product to a friend. |
| Review | The detailed review or feedback provided by the customer. |
| Review Summary | A concise title or summary of the review. |
| Review Title | A title given by the reviewer to their review. |
| Size | Information about the size of the product. |
| Upload Image | A feature that allows customers to upload images of the product they purchased. |
| What is your gender | Gender information of the reviewer. |
| What is your age | The age of the reviewer. |
| Width | Information about the width of the product (dimension). |
| Product Id | A unique identifier for the purchased product. |
| Product name | The name of the purchased product. |
| Product Description | A description of the purchased product. |
| Product URL | A link to the product on the e-commerce site. |
| Product Image URL | A link to an image of the product. |
| Rating Image URL | Links to images representing different rating options (blank and filled stars, for example). |
| Additional feedback on customer service | Additional comments or feedback related to the customer service experience. |
| First Name | The first name of the reviewer. |
| Last Name | The last name of the reviewer. |
| City | The city name of the registered customer. |
| State | The state in which the registered customer resides. |
| Country | The country of the registered customer. |
| Product Recommended | Whether the reviewer would recommend the product to others. |
Other Additional Data Fields
| Field Name | Description |
|---|---|
| Nickname/First Name, Last Name | The first name or Nick name, and Last name of the registered customer. |
| Email ID | Email Address of the reviewer. For Example "somebody@who.com" |
| Age | The age of the reviewer. |
| Gender | The gender of the reviewer. |
| Location/ City, State, Country | The reviewer's location, which includes the country, city, or state. |
| Product Recommend/Bottom Line | Is the product recommended by the reviewer |
| Site Recommend | Is the site recommended by the reviewer |
| Overall Rating | A rating representing the reviewer's overall satisfaction with the product. |
| Review title/Review summary | The title or headline for the review. A summary of the review. |
| Review | The main body of the product review. |
| Attachments | Image/YouTube URL added by reviewer |
| Custom fields | Rest of the fields (For Example: vehicle type, skin tone, pros, cons, dimension.) |
Questions & Answer (Q&A)
| Q&A Data Field | Description |
|---|---|
| from_name | Name of the customer who submitted the question or answer. |
| from_email | Email address of the customer who submitted the question or answer. |
| product_page_url | URL of the product page where the Q&A functionality is implemented. |
| product_name | Name of the product for which the Q&A functionality is implemented. |
| address | The location of the customer. |
| post type | Indicates whether the entry is a question or an answer. |
| Date | The date when the question was asked or the answer was provided. |
| product_image_url | URL of the product image, which can be used to reference the product. |
| admin_emails | Email address of the admin or moderators managing the Q&A system. |
| question | The actual question related to the product. |
| asked_by | Indicates who asked the question, typically a customer. |
| qus_db_add_date | Date when the question was saved in the database. |
FAQ
Q- What is Site ID?
Ans - Unique ID for every e-commerce site to integrate with AC.
Glossary
| Terminology | Description |
|---|---|
| AC | Annex Cloud |
| RAAS | Registration As A service |