Loyalty APIs (3.0.0)

Customer loyalty drives successful enterprises, representing the trust and emotional connection consumers develop with brands over time. In today's competitive landscape with evolving customer expectations, retaining existing customers is as crucial as attracting new ones. Our Customer Loyalty API revolutionizes customer engagement by enabling seamless integration of loyalty programs into your applications, websites, and platforms. This solution empowers businesses of all sizes with personalized experiences, targeted rewards, and data-driven insights to enhance customer lifetime value. This documentation guides you through integration with detailed explanations, endpoints, examples, and best practices suitable for both newcomers and experienced developers.

Key Features-

Customer Enrollment - Easily register customers with minimal API calls

Points and Rewards Management - Track points and incentivize engagement

Personalized Promotions - Create targeted offers based on individual preferences

Data Analytics - Gain insights into customer behavior for informed decisions

Security and Compliance - Protect customer data with robust security measures

Seamless Integration - Compatible with various platforms for hassle-free implementation

Download OpenAPI description
Languages
Servers

https://s15.socialannex.net/api/3.0/

Users

Welcome to the User API Documentation for Annex Cloud! This comprehensive guide is designed to empower developers, administrators, and system integrators with the knowledge and tools necessary to seamlessly interact with our loyalty platform's user-related functionalities. As the cornerstone of our customer engagement ecosystem, the Users API enables you to effortlessly manage user profiles, personalize experiences, and unlock the full potential of our loyalty solutions.

Whether you're aiming to integrate user registration into your application, retrieve user information for tailored experiences, or track user activity for insightful analytics, this documentation will serve as your compass in navigating the world of user management within our loyalty-based framework. We understand that your technical expertise is as unique as the experiences you aim to deliver to your users, and that's why we've crafted this guide to be both informative for newcomers and insightful for seasoned developers.

By leveraging the power of the User API, you'll gain the ability to create, update, and retrieve user profiles, harnessing valuable data to drive loyalty strategies and cultivate lasting relationships. From conceptual overviews to in-depth endpoints and practical examples, we've curated a resource that not only imparts technical know-how but also encourages innovation and creativity in building user-centric solutions.

Thank you for choosing Annex Cloud as your partner in loyalty solutions.

Operations

Points

Welcome to the Points API documentation for Annex Cloud, your gateway to unlocking a world of loyalty-based rewards and customer engagement. In this comprehensive guide, we'll walk you through the powerful capabilities of our Points API, designed to seamlessly integrate with your systems and empower you to create unforgettable experiences for your customers.

At Annex Cloud, we understand that building lasting relationships with your customers is at the core of your business. Our Points API provides you with the tools to effortlessly implement a robust loyalty program that not only drives customer retention but also enhances brand affinity. Whether you're a developer looking to integrate our API or a business leader seeking to harness the potential of loyalty rewards, this documentation will equip you with the knowledge and insights needed to succeed.

From awarding points for purchases and referrals to offering personalized rewards and exclusive perks, our Points API puts the control in your hands. With clear and concise endpoints, accompanied by code samples and real-world use cases, you'll be able to quickly grasp the API's functionality and start building innovative loyalty solutions that set you apart in today's competitive market.

Get ready to embark on a journey that goes beyond transactions. Let's dive into the intricacies of the Points API, where creativity meets technology to redefine the way you connect with your customers and drive sustainable business growth.

Operations

To deduct or award loyalty points to multiple members

Request

This method allows you to simultaneously deduct or award points to multiple members. To make a bulk point adjustment you will number each object in the request. Nested within each object, you must include the id, actionId, and activity parameters. If you are manually crediting points or debiting points, you must also include the credit or debit parameter accordingly. If you are crediting points for a point awarding action configured in the loyalty program, you do not need to include the credit parameter, as it will award the member points as configured in the system for that action ID.

Bodyapplication/json
1objectrequired

Enter the following details of the member.

1.​idstring

Enter the member's unique ID.

Example: "user@domain.com"
1.​actionIdstring

Enter the unique action ID for awarding or deducting points from the member's account. For instance, the action ID for manual credit is 100.

Example: "100"
1.​activitystring

Enter the activity as CREDIT or DEBIT.

Example: "CREDIT"
1.​debit/creditinteger

Enter the number of points to be credited or debited from the member’s account.

Example: 100
1.​reasonstring

Enter the reason for awarding or deducting points from the member's account.

Example: "Bonus points"
1.​storeIdstring

Enter the store ID, a unique number used to identify the specific store. Note - If a store ID is provided with any action and it exists in the metadata, all associated attributes of that store will be displayed. If the store ID does not exist in the metadata, it will simply display the store ID itself.

Example: "IN12369"
curl -i -X POST \
  https://s15.socialannex.net/api/3.0/bulkpoints \
  -H 'Content-Type: application/json' \
  -d '{
    "1": {
      "id": "user@domain.com",
      "actionId": "100",
      "activity": "CREDIT",
      "debit/credit": 100,
      "reason": "Bonus points",
      "storeId": "IN12369"
    }
  }'

Responses

Successful operation | AC1026 Points cannot be awarded due to limit reached|AC1028 Points can be earned next in

Body
siteIdstring

Displays Annex Cloud’s site ID for the loyalty program.

Example: "29235480"
idstring

Displays the unique ID of the member.

Example: "user@domain.com"
actionIdstring

Displays the unique action ID for which the member is awarded or deducted points.

Example: 101
activitystring

Displays whether the activity is a credit or a debit.

Example: "CREDIT"
credit/debitinteger

Displays the number of points credited to or debited from the member's account.

Example: 100
storeDetailsobject

Displays the following store details associated with the store. Note - If a store ID is provided with any action and it exists in the metadata, all associated attributes of that store will be displayed. If the store ID does not exist in the metadata, it will simply display the store ID itself.

pointsAwardedinteger

Displays the number of points awarded to the member’s account for performing the action.

Example: 100
reasonstring

Displays the reason for awarding points to the member’s account.

Example: "bonus"
updatedAvailablePointsinteger

Displays the updated number of available points in the member’s account after points have been awarded or debited.

Example: 100
updatedLifetimePointsinteger

Displays the updated total number of points the member has earned in their lifetime with the loyalty program after points have been awarded.

Example: 200
previousTierstring

Displays the member’s previous tier before the points were awarded or debited.

Example: "Silver"
updatedUserTierstring

Displays the member’s updated tier after the points are awarded or debited.

Example: "Gold"
Response
{ "siteId": "29235480", "id": "user@domain.com", "actionId": 101, "activity": "CREDIT", "credit/debit": 100, "storeDetails": { "storeId": "IN12369", "storeName": "SHELL", "storeExtendedAttribute": "Store Location" }, "pointsAwarded": 100, "reason": "bonus", "updatedAvailablePoints": 100, "updatedLifetimePoints": 200, "previousTier": "Silver", "updatedUserTier": "Gold" }

To retrieve point details for a member

Request

This method retrieves point details associated with a member’s ID. The member needs to use their ID as a key to fetch all the points details.

Path
memberIdstringrequired

Enter the unique ID of the member.

Example: user@domain.com
curl -i -X GET \
  'https://s15.socialannex.net/api/3.0/points/{user@domain.com}'

Responses

Successful operation | AC1026 Points cannot be awarded due to limit reached|AC1028 Points can be earned next in

Body
siteIdstring

Displays Annex Cloud’s site ID for the loyalty program.

Example: 146031180
idstring

Displays the unique ID of the member.

Example: "user@domain.com"
availablePointsinteger

Displays the number of available points in the member’s account.

Example: 6620
usedPointsinteger

Displays the total number of points deducted from the member’s account. This excludes points debited as part of Action ID 192, ensuring clarity and precise tracking of point usage.

Example: 2000
negativePointsinteger

Displays the total number of negative points in the member’s account.

Example: -50
expiredPointsinteger

Displays the total number of points that have expired from the member's account. This includes points associated with Action ID 106 as well as points debited under Action ID 192 - Action Debit Points, both categorized as expired.

Example: 0
lifetimePointsinteger

Displays the number of points the member has earned in their lifetime with the loyalty program.

Example: 8620
earnedPointsPeriodstring

Displays the period during which points are earned by the member. For example, Anniversary Year, calendar year, quarter, semester. (Displays only when earned points display flag is enabled in the configuration).

Example: "anniversary year"
earnedPointsinteger

Displays the total number of points earned by the member within the selected time period.

Example: 640
holdPointsinteger

Displays the total number of points on hold in the member’s account.

Example: 0
usedPointsOnRewardinteger

Displays the total number of points used by the member on rewards.

Example: 0
pointsToExpireinteger

Displays the total number of expired points, indicating that the member had not used these points within the specified date range.

Example: 10
pointsToNextTierinteger

Displays the number of points needed for the member to achieve the next tier.

Example: 0
spendToNextTierinteger

Displays the amount that the member needs to spend to achieve the next tier.

Example: 0
pointsToExpireDatestring

Displays the date on which the points will expire in yyyy-MM-dd'T'HH:mm:ssZ format.

Example: "2024-04-28T06:02:06+0000"
totalSpentinteger

Displays the total dollar amount the member has spent.

Example: 375
rewardDenominationinteger

Displays the denomination value associated with the reward.

Example: 500
creditsToCurrencyRatiointeger

Displays the credit-to-currency ratio defined by the admin. Multiplying this ratio by the member's available points results in the total currency value of the available points.

Example: 110
creditsToCurrencyValuestring

Displays the total currency value after multiplying the available points with the credit-to-currency ratio, rounded to the defined decimal place. Note - Set the ‘Credit to Currency Value Up To’ configuration in the ADR to 2 decimal places. This ensures a consistent response format by always returning the value as a string data type.

Example: 10.5
ytdCreditPointsinteger

Displays the total number of points credited to the member’s account from the beginning of the year up to the current date.

Example: 8620
ytdDebitPointsinteger

Displays the total number of points debited from the member’s account from the beginning of the year up to the current date.

Example: 2000
multiBucketsDataobject

Displays an array of all multi- bucket details with the following fields.

availableRedemptionPointsinteger

Displays the total number of available points for redemption in the member’s account.

Example: 0
usedRedemptionPointsinteger

Displays the total number of points used for redemption in the member’s account.

Example: 0
groupDetailsobject

Displays the following information about the group with which the member is associated.

Response
{ "siteId": 146031180, "id": "user@domain.com", "availablePoints": 6620, "usedPoints": 2000, "negativePoints": -50, "expiredPoints": 0, "lifetimePoints": 8620, "earnedPointsPeriod": "anniversary year", "earnedPoints": 640, "holdPoints": 0, "usedPointsOnReward": 0, "pointsToExpire": 10, "pointsToNextTier": 0, "spendToNextTier": 0, "pointsToExpireDate": "2024-04-28T06:02:06+0000", "totalSpent": 375, "rewardDenomination": 500, "creditsToCurrencyRatio": 110, "creditsToCurrencyValue": 10.5, "ytdCreditPoints": 8620, "ytdDebitPoints": 2000, "multiBucketsData": { "bucketName": {} }, "availableRedemptionPoints": 0, "usedRedemptionPoints": 0, "groupDetails": { "groupId": "91", "groupName": "Loyalty Circle", "groupAvailablePoints": "500", "groupLifetimePoints": "100", "groupUsedPoints": "200", "groupExpiredPoints": "0" } }

Fetches the point expiration details for a specific member

Request

This API is used to fetch the point expiration details for a member based on the specified date range and page number as provided by the user.

Path
memberIdstringrequired

Enter the unique ID of the member.

Example: user@domain.com
start_datestringrequired

Enter the date on which you’d like to start pulling point expiration data for the member in yyyy-MM-dd'T'HH:mm:ssZ format.

Example: 2024-04-28T06:02:06+0000
end_datestringrequired

Enter the date on which you’d like to stop pulling point expiration data for the member in yyyy-MM-dd'T'HH:mm:ssZ format.

Example: 2024-04-28T06:02:06+0000
aggregate_bystringrequired

Enter a value to group points in a date range that have expired or are about to expire in a week, month, quarter, or year.

Example: month
pageintegerrequired

Enter the total number of pages of the point expiration details for the member.

Example: 1
curl -i -X GET \
  'https://s15.socialannex.net/api/3.0/pointsexpiry/{user@domain.com}'

Responses

Successful operation | AC1026 Points cannot be awarded due to limit reached|AC1028 Points can be earned next in

Body
siteIdstring

Displays Annex Cloud’s site ID for the loyalty program.

Example: 146031180
idstring

Displays the unique ID of the member.

Example: "user@domain.com"
expiryDetailobject

Displays the point expiration details for the member.

pointsActivityobject

Displays points details for the time block.

pagesinteger

Displays the total number of pages for the member’s point expiration details.

Example: 1
currentPageinteger

Displays the page number for the fetched member details.

Example: 1
totalExpiryDetailCountinteger

Displays the total number of point expiration details for the member.

Example: 2
Response
{ "siteId": 146031180, "id": "user@domain.com", "expiryDetail": { "date": "2024-04" }, "pointsActivity": { "points": 2010, "expiryDate": "2024-04-28T06:02:06+0000", "totalPointsToExpire": 2010, "totalPointsExpired": 0 }, "pages": 1, "currentPage": 1, "totalExpiryDetailCount": 2 }

To deduct points, redeem points and award loyalty points to a member

Request

Use the POST method in the Points API to redeem points and award points to members of the loyalty program. All other fields in the request body are listed below.

Bodyapplication/json
bodyobject

Different body parameters are shown below depending on whether you’d like to redeem points or award points.

curl -i -X POST \
  https://s15.socialannex.net/api/3.0/points \
  -H 'Content-Type: application/json' \
  -d '{
    "body": {
      "To Redeem Rewards": {
        "id": "user@domain.com",
        "actionId": 107,
        "customId": "gadget01",
        "rewardId": "121",
        "groupId": "91",
        "activity": "DEBIT",
        "orderId": "A12345",
        "retry": "YES",
        "reason": "points redeemed for discount",
        "storeId": "IN12369",
        "source": "web",
        "allowNegativePoints": "2",
        "vendorEmail": "vendor@domain.com",
        "vendorName": "John mark",
        "actionAttribute": {
          "attributeValue": "shirt size"
        }
      },
      "To Redeem Custom Points": {
        "id": "user@domain.com",
        "actionId": 107,
        "customId": "gadget01",
        "activity": "DEBIT",
        "orderId": "A12345",
        "debit": 121,
        "reason": "custom points redeemed for discount",
        "storeId": "IN12369",
        "source": "web",
        "actionAttribute": {
          "attributeValue": "shirt size"
        }
      },
      "To Award Points": {
        "id": "user@domain.com",
        "actionId": 100,
        "customId": "gadget01",
        "activity": "CREDIT",
        "credit": 435,
        "pointType": "Standard or Promotional",
        "campaignId": 12345,
        "orderId": "A12345",
        "source": "web",
        "reason": "bonus",
        "storeId": "IN12369",
        "actionAttribute": {
          "attributeValue": "shirt size"
        }
      },
      "To Award or Deduct Custom Points from a member’s account": {
        "id": "user@domain.com",
        "actionId": 100,
        "activity": "CREDIT or DEBIT",
        "source": "web",
        "orderId": "A12345",
        "credit or debit": 435,
        "Credit[bucketName]": 100,
        "TierCredit[bucketName]": 200,
        "reason": "bonus",
        "storeId": "IN12369",
        "sectionId": "654",
        "sectionName": "main section",
        "surveyId": "123",
        "surveyName": "general survey",
        "customId": 1022,
        "actionAttribute": {
          "attributeValue": "shirt size"
        }
      },
      "Transfer Group Points to Members": {
        "id": "user@domain.com",
        "actionId": 160,
        "groupId": "91",
        "activity": "DEBIT",
        "orderId": "A12345",
        "debit": 435,
        "reason": "points transferred",
        "userId": "user@domain.com",
        "actionAttribute": {
          "attributeValue": "moto"
        }
      },
      "Transfer Member Points to Group": {
        "id": "user@domain.com",
        "actionId": 160,
        "groupId": "91",
        "activity": "CREDIT",
        "debit": 435,
        "reason": "points transferred",
        "recipientData": {
          "recipientId": "r00.000@annexcloud.com"
        }
      },
      "Transfer Points between Two Individual Members": {
        "id": "user@domain.com",
        "actionId": 8055,
        "activity": "DEBIT",
        "debit": 435,
        "recipientData": {
          "recipientId": "r00.000@annexcloud.com"
        }
      }
    }
  }'

Responses

Successful operation | AC1026 Points cannot be awarded due to limit reached|AC1028 Points can be earned next in

Body
To Redeem Rewardsobject
To Redeem Custom Pointsobject
To Award Pointsobject
To Award Custom Pointsobject
To Deduct Custom Pointsobject
Transfer Points between Group Membersobject
Transfer Member Points to Groupobject
Transfer points between two membersobject
Response
{ "To Redeem Rewards": { "siteId": 99383640, "id": "user@domain.com", "rewardId": 121, "rewardName": "Premium Member Discount", "rewardCategory": "Nee Reward01", "rewardCategoryId": 413, "rewardDescription": "Get 25% off your first product purchase.", "rewardTerms": "Points can be redeemed for rewards according to the current redemption schedule. Rewards may include discounts, merchandise, or other specified offers. Rewards are subject to availability and may be changed or discontinued at any time without notice. By participating in the Loyalty Program, you acknowledge that you have read, understood, and agree to abide by these terms and conditions.", "activity": "debit", "orderId": "12132ab", "debit": 121, "storeDetails": {}, "reason": "claim", "customId": "gadget01", "source": "web", "pointsDeducted": 300, "groupDebit": 20, "groupPointsDeducted": 20, "rewardCode": 4260, "rewardCodeExpDate": "2020-10-30T05:30:00", "updatedUserTier": "Gold", "previousTier": "Silver", "rewardAttribute": "Vat", "updatedAvailablePoints": 4545, "updatedLifetimePoints": 7860, "actionAttribute": {}, "multiBucketsData[bucketName]": {}, "tier[bucketName]": {} }, "To Redeem Custom Points": { "siteId": 99383640, "id": "user@domain.com", "actionId": 100, "orderId": "12132ab", "rewardId": 12132, "activity": "debit", "debit": 500, "storeDetails": {}, "pointsDeducted": 100, "reason": "claim", "customId": "gadget01", "source": "web", "campaignId": 12132, "campaignName": "festival bonanza", "campaignPoints": 200, "updatedAvailablePoints": 900, "updatedLifetimePoints": 1327, "actionAttribute": {}, "previousTier": "Silver", "updatedUserTier": "Gold" }, "To Award Points": { "siteId": 99383640, "id": "user@domain.com", "actionId": 100, "orderId": "12132ab", "activity": "credit", "credit": 50, "storeDetails": {}, "pointType": "Standard or Promotional", "pointsAwarded": 50, "reason": "bonus", "customId": "id12345", "source": "web", "updatedUserTier": "Gold", "previousTier": "Silver", "updatedAvailablePoints": 4545, "updatedLifetimePoints": 7860, "actionAttribute": {}, "campaignDetails": {} }, "To Award Custom Points": { "siteId": 99383640, "id": "user@domain.com", "actionId": 100, "orderId": "12132ab", "activity": "credit", "credit": 50, "pointsAwarded": 50, "reason": "bonus", "storeDetails": {}, "customId": "id12345", "sectionId": 654, "sectionName": "main section", "surveyId": 123, "surveyName": "general survey", "source": "web", "campaignId": 12132, "campaignName": "festival bonanza", "campaignPoints": 121, "updatedUserTier": "Gold", "previousTier": "Silver", "updatedAvailablePoints": 4545, "updatedLifetimePoints": 7860, "actionAttribute": {}, "multiBucketsData[bucketName]": {}, "tier[bucketName]": {} }, "To Deduct Custom Points": { "siteId": 99383640, "id": "user@domain.com", "actionId": 100, "activity": "debit", "orderId": "12132ab", "debit": 50, "storeDetails": {}, "pointsDeducted": null, "pointsNotDeducted": 50, "reason": "adjustment", "customId": "id12345", "updatedUserTier": "Gold", "previousTier": "Silver", "updatedAvailablePoints": "general survey", "updatedLifetimePoints": 7860, "actionAttribute": {}, "multiBucketsData[bucketName]": {}, "tier[bucketName]": {} }, "Transfer Points between Group Members": { "siteId": 9991331, "id": "user@domain.com", "activity": "debit", "debit": 10, "pointsDeducted": 10, "reason": "claim", "updatedAvailablePoints": 250, "updatedLifetimePoints": 250, "previousTier": "Silver", "updatedUserTier": "Gold", "actionAttribute": {}, "hierarchy Data": {} }, "Transfer Member Points to Group": { "siteId": 9991331, "id": "user@domain.com", "actionId": 160, "activity": "credit", "credit": 435, "pointsAwarded": 435, "reason": "transfer points to group", "updatedAvailablePoints": 200, "updatedLifetimePoints": 250, "previousTier": "Silver", "updatedUserTier": "Gold", "actionAttribute": {}, "hierarchy Data": {}, "error code": "error", "error message": "fail" }, "Transfer points between two members": { "siteId": 9991331, "id": "user@domain.com", "actionId": 8055, "activity": "debit", "debit": 20, "pointsDeducted": 20, "pointsNotDeducted": 30, "groupDebit": 20, "groupPointsDeducted": 20, "updatedAvailablePoints": 200, "reason": "transfer points request", "updatedLifetimePoints": 250, "previousTier": "Gold", "updatedUserTier": "Silver", "recipientData": {} } }

Action

Welcome to the Action API Documentation for Annex Cloud! We understand that crafting an exceptional loyalty program involves more than just rewarding points—it's about creating dynamic and engaging experiences for your customers. Our Loyalty Actions API is your gateway to elevating your loyalty program, allowing you to design and implement meaningful interactions that resonate with your audience. The Loyalty Actions API by Annex Cloud is a powerful tool designed to help you go beyond traditional loyalty rewards. With this API, you can:

Drive Customer Engagement- Create interactive and personalized experiences to keep your customers actively involved in your loyalty program.

Enable Real-time Interactions- Implement actions that trigger instantly based on customer behavior, ensuring timely and relevant rewards.

Enhance User Experience- Seamlessly integrate actions into your existing applications, websites, and platforms to provide a cohesive and enjoyable user experience.

Encourage Desired Behaviors- Design and deploy actions that align with your business objectives, encouraging customers to take specific actions that benefit both them and your brand.

At Annex Cloud, we believe in the power of meaningful interactions to strengthen the bond between your brand and your customers. This documentation is your key to unlocking the full potential of our Loyalty Actions API, and we're excited to embark on this journey with you. Thank you for choosing Annex Cloud to enhance your loyalty program, and let's create extraordinary experiences together! Let's get started!

Operations

Activity

Welcome to the Activity API documentation for Annex Cloud! Here, we are excited to guide you through the dynamic world of loyalty-based interactions and engagement. Our Activity API empowers you to seamlessly integrate and enhance your loyalty program with real-time activity tracking, enabling you to craft personalized experiences for your valued customers.

In this comprehensive guide, you will find everything you need to know to leverage the full potential of our Activity API. Whether you are a seasoned developer looking to integrate our API into your existing systems, or a business visionary seeking to create innovative loyalty solutions, we have got you covered.

From tracking points accumulation and rewards redemption to monitoring user interactions and crafting targeted campaigns, our Activity API opens doors to a new realm of customer engagement possibilities. We understand the significance of fostering lasting relationships with your clientele, and this API paves the way for fostering those connections in meaningful and profitable ways.

Through easy-to-follow examples, detailed endpoints, request and response formats, this documentation will empower you to harness the power of our Activity API effectively.

Explore the API, experiment with its capabilities, and unlock the potential to redefine loyalty experiences for your customers. The possibilities are boundless, and the rewards are waiting. Let us get started!

Operations

Tiers

Welcome to the Tiers API Documentation for Annex Clouds cutting-edge loyalty program platform. Our Tiers API empowers developers, businesses, and partners to seamlessly integrate and enhance their applications with our dynamic and customizable loyalty tiers system. This API documentation serves as your comprehensive guide to understanding and implementing the Tiers API, unlocking the full potential of loyalty-driven engagement for your customers.

Whether you are looking to reward long-term patrons, incentivize higher spending, or create personalized experiences for your member base, our Tiers API offers a versatile solution that aligns with your unique business goals. By integrating this API, you can effortlessly design and manage multi-tiered loyalty structures that captivate, engage, and retain your audience, all while enjoying the ease of integration and scalability that our platform provides.

Throughout this documentation, we will delve into the core functionalities of the Tiers API, walking you through the steps to seamlessly incorporate loyalty tiers into your applications. From setting up tier parameters and defining eligibility criteria, to handling tier transitions and leveraging tier-specific benefits, we have got you covered with clear instructions and code examples.

Operations

Rewards

At Annex Cloud, we understand the power of loyalty and the importance of rewarding your customers for their continued support. Our Loyalty Rewards API is designed to help you seamlessly integrate and enhance your loyalty program, making it easier than ever to create engaging, customized, and rewarding experiences for your customers. Using our Rewards API, you can easily access and utilize members' rewards data, allowing you to keep tabs on your loyal customer base, their preferences, and their engagement with your program. Additionally, you can access a comprehensive list of rewards used by your members, providing insights into what incentives are most appealing and effective.

This documentation covers everything you need to get started with our Loyalty Rewards API, including detailed information on available API endpoints and how to use them.

Thank you for choosing Annex Cloud for your loyalty needs, and we look forward to helping you build stronger, more loyal customer relationships.

Operations

Segment

Segment module can be used to differentiate the Users into groups which can be used in other loyalty modules for offers or campaigns. Define segments and conditions and use them to incentivize your members.

Operations

Campaign

Welcome to the Loyalty Program Campaigns API Documentation for Annex Cloud! This comprehensive guide is designed to empower developers, businesses, and stakeholders to seamlessly integrate and leverage our Loyalty Program Campaigns API within their applications and systems.

Our loyalty-based company understands the significance of fostering meaningful relationships with our valued customers. As such, we have crafted a powerful API that enables businesses to create, manage, and optimize loyalty campaigns, driving customer engagement, loyalty, and retention.

Annex Cloud’s Loyalty Program Campaigns API is a robust and flexible tool that facilitates the integration of our loyalty program capabilities into your applications and platforms. Through this API, you can design and execute diverse loyalty campaigns, offering tailored rewards and incentives to your customers based on their actions, purchases, or interactions with your brand.

By integrating our API, you unlock a plethora of benefits:

Customized Loyalty Campaigns: Design unique loyalty campaigns that align with your business goals and resonate with your customer base.

Enhanced Customer Engagement: Drive customer engagement by offering personalized rewards and promotions, enhancing their loyalty and advocacy.

Real-time Performance Insights: Obtain real-time analytics and insights into the performance of your loyalty campaigns, allowing you to optimize strategies for maximum effectiveness.

Seamless Integration: Easily integrate the Loyalty Program Campaigns API into your existing systems, ensuring a smooth and efficient loyalty program management process.

This documentation covers essential aspects, endpoints, request and response examples, and best practices to ensure a seamless integration and utilization of the Loyalty Program Campaigns API. Let's embark on this journey to elevate your loyalty programs and build lasting connections with your cherished customers.

Operations

Orders

Welcome to the Orders API documentation for Annex Cloud, where loyalty and seamless customer experiences converge. This API empowers developers, partners, and integrators to tap into the core of our loyalty-based ecosystem, enabling the creation of innovative and personalized solutions that enhance customer engagement and drive business growth.

In this comprehensive guide, you will find all the essential information needed to integrate with our Orders API seamlessly. Whether you're a seasoned developer seeking to leverage the power of loyalty data or a business owner aiming to enhance customer satisfaction, this documentation will serve as your compass to navigate the world of loyalty-driven transactions.

From placing orders and tracking purchases to utilizing loyalty rewards within the checkout process, the Orders API opens a realm of possibilities. By harnessing this interface, you can craft applications that bridge the gap between exceptional user experiences and business success.

We've designed this documentation to provide clear insights into the capabilities, endpoints, authentication, and best practices for utilizing the Orders API effectively. As you embark on this integration journey, we encourage you to explore the diverse use cases, reference implementations, and code snippets that will help you hit the ground running.

Thank you for choosing Annex Cloud as your partner in delivering unparalleled loyalty experiences. Let's dive into the intricacies of the Orders API and pave the way for loyalty-driven innovation that transforms the way customers interact with your brand.

Operations

BlockList

Welcome to Annex Cloud's Loyalty Blocklist API- a powerful tool designed to fortify the security and integrity of your loyalty program. In the dynamic landscape of customer engagement and rewards, ensuring the trustworthiness of your platform is paramount. Our Blocklist API is crafted to be the guardian of your loyalty ecosystem, providing a robust defense against fraudulent activities, unauthorized access, and other potential threats.

Elevate your loyalty program security with Annex Cloud's Loyalty Blocklist API.

Operations

Product

Welcome to the Annex Cloud Products API Documentation! We're excited to have you here as you explore the powerful tools and capabilities our Loyalty Program offers through this API.

At Annex Cloud, we understand the significance of fostering customer loyalty. Our mission is to help businesses like yours build lasting relationships with their customers by offering engaging and rewarding loyalty programs. Our Products API is a key component of this mission, allowing you to seamlessly integrate our loyalty features into your applications and systems.

This documentation is designed to be your comprehensive guide to using our Products API effectively. Whether you're a seasoned developer looking to dive into the technical details or a business owner seeking to enhance customer engagement, you'll find valuable information here to help you get started and make the most of our loyalty solutions.

To begin using our Products API, you'll need an API key and a clear understanding of how our endpoints work. We've organized this documentation into user-friendly sections, including:

Authentication: Learn how to securely authenticate your requests.

Endpoints: Explore the various API endpoints available and how to use them effectively.

Examples: Find practical examples and use cases to inspire your integration.

We're here to support you on your journey to building a more loyal customer base and boosting your business's success. If you have any questions or need assistance, please don't hesitate to reach out to our dedicated support team.

Thank you for choosing Annex Cloud as your partner in loyalty. Let's work together to create rewarding experiences for your customers.

Operations

Others

At Annex Cloud, we understand the diverse needs of our clients and the dynamic landscape of the loyalty industry. The Others API is crafted to cater to specific requirements that go beyond the standard functionalities, offering you flexibility and customization. Through strategic utilization of Store ID and Site ID, you gain the power to precisely identify and manage various aspects of your loyalty program across different stores and sites. We invite you to delve into the Others API and elevate your loyalty strategy to meet the specific needs of your audience and unlock new dimensions of customer engagement.

Operations

Survey

Welcome to the Survey API documentation for Annex Cloud! This comprehensive guide provides all the essential information and resources needed to integrate and interact with our survey platform programmatically. Our Survey API allows you to seamlessly integrate our powerful survey capabilities into your applications, websites, or systems. With this API, you can create, manage, and retrieve surveys, questions, responses, and more, empowering you to tailor survey experiences that align with your unique requirements. This documentation is designed to assist you in understanding how to leverage our API effectively, enabling you to:

Create Surveys: Dynamically generate surveys with specific questions and formats to suit your needs.

Retrieve Survey Data: Access survey responses and other relevant data for analysis or display.

Manage Surveys and Questions: Edit, delete, or modify existing surveys and questions to maintain an up-to-date and relevant survey structure.

Integrate Seamlessly: Integrate the survey capabilities seamlessly into your existing applications or platforms to collect valuable insights.

The subsequent sections will guide you through the necessary steps, providing examples and explanations to facilitate a smooth integration process.

Operations

Store

Welcome to the Store API documentation for Annex Cloud! We are thrilled to walk you through the exciting world of loyalty-based interactions and engagement. Our Store API allows you to seamlessly integrate and enhance your loyalty program by tracking real-time store details, enabling you to create personalized experiences for your valued customers.

The Store API is used to create stores in bulk, update the information of the created stores, and fetch all the details of the existing stores. Each store is identified by a unique store ID, which distinguishes it from other stores.

Operations

Hierarchy Management

Welcome to the Hierarchy Management API documentation for Annex Cloud! We are thrilled to walk you through the exciting world of loyalty-based interactions and engagement. Our Hierarchy Management API allows you to seamlessly integrate and enhance your loyalty program by tracking real-time Hierarchy Management details, enabling you to create personalized experiences for your valued customers.

The API methods covered in this document will enable you to create new groups, manage the activities of existing groups, and retrieve group details.

Operations

Issuance

Welcome to the Annex Cloud Issuance API documentation, where loyalty and seamless customer experiences converge. This comprehensive guide provides everything you need to seamlessly integrate with our transaction/issuance API. Whether you’re an experienced developer leveraging loyalty data or a business owner enhancing customer satisfaction, this documentation will guide you through the world of loyalty-driven transactions.

The Order API lacks the ability to handle specific dynamic attributes during order creation. To address this limitation, we have introduced the Issuance API, designed to store and process orders. Unlike the Order API, this new API does not include predefined calculations and mirrors the functionalities of the Order API.

Clients who would like to leverage more dynamic order attributes using the Issuance API will need to first calculate the points for spending and determine how members earn points. They will then send this value to our API, which should then accept it and grant the corresponding benefits based on the received payload.

Operations

Receipt

At Annex Cloud, we recognize the significance of loyalty and the value of rewarding your customers for their ongoing support. Our Loyalty Receipts API is designed to help you seamlessly integrate and enhance your loyalty program by enabling receipt upload, verification, and reward management, making it easier than ever to create engaging, customized, and rewarding experiences for your customers.

This documentation covers all aspects of the receipt upload and verification process. Once a receipt is successfully verified, members will earn points that they can redeem for coupons or use to purchase products based on their preferences.

Thank you for choosing Annex Cloud for your loyalty needs. We look forward to assisting you in building stronger and more loyal customer relationships.

Operations