Objective
The purpose of this document is to describe the supporting Annex Cloud data fields to corresponding Sailthru fields. The fields can be customized based on the requirements.
Supported Versions
| Supported Versions | Certified Versions |
|---|---|
| -- | -- |
Supporting Data Fields for Sailthru
| Feature Name | Description | Pre-Requisites | Configuration Details | Reference Documents |
|---|---|---|---|---|
| Create a new customer contact in Sailthru | When a customer enrolls in Annex Cloud Loyalty and the customer does not yet exist in Sailthru, then customer contact gets created in Zauis. |
|
NA | NA |
| Passing of Customer Loyalty data in Sailthru | Customer Loyalty data will be pushed against a customer contact in Sailthru |
|
NA | NA |
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 are 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)
| VC Field | Description |
| ac_vc_name | This field represents the full name of the registered user. It is likely used to capture the user's name during the registration process. |
| ac_vc_email | This field is used to capture the email address of the registered user. It typically serves as a unique identifier for user accounts and is used for communication and account recovery. For Example: somebody@who.com |
| ac_vc_product code | This field is an identifier associated with the product linked to the user or their account. It may help in tracking which product(s) a user has purchased or is associated with. |
| ac_vc_instagram photo url | This field stores the URL of a photo that the user has posted on Instagram. This might be used in scenarios where users are encouraged to share their photos related to a product or service. |
| ac_vc_subscribed | This field likely indicates the newsletter signup status of the user. It may be a binary field with values like "subscribed" or "not subscribed," indicating whether the user has opted in to receive newsletters or updates from the service. |
Ratings & Review (R&R)
| Data Fields | Description |
|---|---|
| Date | The date when the review was submitted. |
| Bottom line | A summary or conclusion about the product. |
| Comfort | Rating or feedback on the comfort level of the product (satisfying/not satisfying). |
| Cons | Negative aspects or drawbacks of the product. |
| Email Address of the reviewer. For Example "somebody@who.com" | |
| Location | The reviewer's location, which includes the country, city, or state. |
| Nickname | The reviewer's chosen nickname or username. |
| Overall rating | A rating representing the reviewer's overall satisfaction with the product. |
| Please tell us why | An open field for the reviewer to explain their rating or provide additional comments. |
| Pros | Positive aspects or strengths of the product. |
| Quality | Feedback on the quality of the product. |
| Recommend Friend | Whether the reviewer would recommend the product to a friend. |
| Review | The main body of the product review. |
| Review Summary | A summary of the review. |
| Review Title | The title or headline for the review. |
| Size | Information about the size of the product. |
| Upload Image | An option for the reviewer to upload images of the purchased product. |
| What is your gender | The gender of the reviewer. |
| What is your age | The age of the reviewer. |
| Width | Information about the width or dimensions of the product. |
| Product Id | A unique identification number 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 blank and filled rating stars. |
| Additional feedback to customer service | An open field for the reviewer to provide additional feedback or comments related to customer service. |
| First Name | The first name of the reviewer. |
| Last Name | The last name of the reviewer. |
| City | The city name of the registered user. |
| State | The state of the registered user. |
| Country | The country of the registered user. |
| 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 user or 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 user who submitted the question or answer. |
| from_email | Email address of the user who submitted the question or answer. |
| product_page_url | URL of the product page where the Q&A is implemented. |
| product_name | Name of the product for which the Q&A is implemented. |
| address | Location of the user (possibly for shipping or geographical context). |
| post type | Indicates whether the content is a question or an answer. |
| Date | The date when the question was asked or answered. |
| product_image_url | URL of the product image associated with the question or answer. |
| admin_emails | Email addresses of the administrators or moderators overseeing the Q&A system. |
| question | The actual question related to the product. |
| asked_by | Indicates who asked the question, For Example: a customer's name. |
| qus_db_add_date | The date when the question was saved in the database. |
FAQ
What is Site ID?
Ans -Unique ID to every e-commerce site to integrate with AC.
Glossary
| Terminology | Description |
|---|---|
| API | Application Programming Interface |
| AC | Annex Cloud |