Objective
The purpose of this document is to describe the Annex Cloud data fields and their corresponding Bronto fields. These data fields can be customized based on specific requirements.
Supported Versions
| API Supported Versions | Certified Versions |
|---|---|
| APIs Version 4 | N/A |
Bronto Supported Feature List
Below is the list of Annex Cloud loyalty data fields mapped to Bronto ESP fields.
Loyalty Data Fields
| Loyalty Field | Description |
|---|---|
| Loyalty ID | A unique platform-specific identifier defined by Annex Cloud. |
| First Name | First name of the registered customer. |
| Last Name | Last name of the registered customer. |
| Email Address | Email address of the registered customer (for example, "somebody@who.com"). |
| Active Status | An indicator showing whether the customer has been active on the platform in the past year. |
| Birthday | Customer’s birthday date. |
| Loyalty Anniversary Date | Date the customer enrolled in the loyalty program. |
| Phone Number | Customer's phone number. |
| Zip Code | Customer's zip code. |
| Opt-in Status | Customer's opt-in status for the loyalty program. |
| Opt-in Date | Date when the customer opted into the loyalty program. |
| Available Points | Points available for redemption. |
| Earned Points | Total points earned during the loyalty membership period. |
| Used Points | Total points redeemed during the loyalty membership period. |
| Hold Points | Points currently held and unavailable for redemption. |
| Next Expiring Points | Points that will expire soon if not used. |
| Points Expiration Date | Date when points will expire if not used. |
| Expired Points | Total number of points that expired during the loyalty membership period. |
| Current Tier | Customer’s current loyalty tier (for example, Gold). |
| Next Tier | Next tier a customer can reach based on their current tier. |
| Points Required for Next Tier | Number of points required to reach the next tier. |
| Tier Achieve Date | Date when the customer achieved their current tier. |
| Available Rewards | List of rewards eligible for redemption, based on available points. For example, 15 dollars = 500 points. |
| Points Required for Next Reward | Points needed to redeem the next available reward. |
| Highest Available Reward | Highest reward available to the customer. |
| First Loyalty Activity Date | Date when the customer performed their first activity after enrolling in the loyalty program. |
| Last Loyalty Activity Date | Date of the customer's most recent activity within the loyalty program. |
| First Purchase Date | Date when the customer made their first purchase. |
| Last Purchase Date | Date of the customer's most recent purchase. |
Refer A Friend Data Fields
| Field | Description |
|---|---|
| Referrer_Email | Email address of the referrer (for example, somebody@who.com). |
| Referrer_First Name | First name of the registered customer referring others. |
| Referrer_Last Name | Last name of the registered customer referring others. |
| Newsletter_Status | Newsletter subscription status of the referrer (Yes or No). |
| Share_Resource | Social media interactions (Facebook, Twitter, Email, Bitly URL). |
| Email_Receiver | Email address of the person receiving the referral link. |
| Bitly_URL | Shortened Bitly URL used in sharing the referral link. |
| Friend_Email | Email address of the friend to whom the referral link is sent. |
| Friend_Name | Name of the friend after making a purchase referral. |
| Coupon_Code | Coupon code received by the friend for the referral. |
| Stat_ID | Option field used during referral registration. |
| Claim_Rewards_URL | URL where the customer can view all claimable rewards. |
| Invite_Code | Unique invitation code for the referrer. |
| Reward_Code | Reward code given to the sharer after the referral. |
| Coupon_Used | Tracks the coupon code used for the referred sale. |
| Credits_Earned | Total credits earned by the sharer through the referral program. |
Visual Commerce (VC) Fields
| VC Field | Description |
|---|---|
| ac_vc_name | Full name of the registered customer. |
| ac_vc_email | Email address of the registered customer (for example, somebody@who.com). |
| ac_vc_product_code | Unique identifier for the product associated with the customer’s image. |
| ac_vc_instagram_photo_url | URL of the photo posted by the customer on Instagram. |
| ac_vc_subscribed | Customer's newsletter subscription status. |
Ratings and Reviews (R&R) Fields
| Data Field | Description |
|---|---|
| Date | Date when the review was submitted. |
| Bottom Line | A brief recommendation about the product (alternative for Product Recommend). |
| Comfort | Comfort level of the product (for example, satisfying, not satisfying). |
| Cons | Negative aspects of the product. |
| Email address of the reviewer (for example, somebody@who.com). | |
| Location | Reviewer's location (city, state, country). |
| Nickname | Nickname of the reviewer. |
| Overall Rating | Overall rating of the product. |
| Please tell us why | Explanation provided if the rating is very low. |
| Pros | Positive aspects of the product. |
| Quality | Product quality rating. |
| Recommend Friend | Whether the reviewer recommends the product to a friend. |
| Review | Detailed review of the product. |
| Review Summary | Same as the review title. |
| Review Title | Title of the review. |
| Size | Size of the product (if applicable). |
| Upload Image | Image of the product purchased by the customer. |
| What is your gender | Gender of the reviewer. |
| What is your age | Age of the reviewer. |
| Width | Width of the product (dimension). |
| Product ID | Identifier of the purchased product. |
| Product Name | Name of the purchased product. |
| Product Description | Description of the purchased product. |
| Product URL | URL link to the product page. |
| Product Image URL | URL link to the product image. |
| Rating Image URL | URLs of the filled and empty rating images. |
| Additional Feedback | Any additional feedback given to customer service. |
| First Name | First name of the reviewer. |
| Last Name | Last name of the reviewer. |
| City | City of the reviewer. |
| State | State of the reviewer. |
| Country | Country of the reviewer. |
| Product Recommended | Whether the product is recommended to others by customers. |
Question and Answer (Q&A) Data Fields
| Q and A Field | Description |
|---|---|
| From Name | Name of the customer asking the question. |
| From Email | Email address of the customer asking the question. |
| Product Page URL | URL of the product page where the Q and A is implemented. |
| Product Name | Name of the product associated with the Q and A. |
| Address | Location of the customer. |
| Post Type | Indicates whether the post is a question or answer. |
| Date | Date when the question or answer was posted. |
| Product Image URL | URL of the product image associated with the Q and A. |
| Admin Emails | Email address of the admin managing the Q and A. |
| Question | Question asked by the customer. |
| Asked By | Name of the customer who asked the question. |
| Qus DB Add Date | Date when the question was added to the database. |
FAQ
Q: What is Site ID?
A: A unique ID assigned to each e-commerce site for integration with Annex Cloud.
Glossary
| Term | Description |
|---|---|
| AC | Annex Cloud |
| R&R | Ratings and Reviews |
| RAF | Refer a Friend |
| VC | Visual Commerce |
| Q&A | Questions and Answers |