# 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.

## Fetch the list of all rewards for a member

 - [GET /users/{{memberId}}/reward](https://annexcloud.redocly.app/loyalty/loyalty/rewards/getrewardsbyuser.md): This method can be used to retrieve a list of all available rewards against a member ID. The administrator needs to pass a unique member ID as the key to fetch the details. A query parameter rewardSequence can be used to sort reward based on sequence. The response body for this method is the same as the response body for the GET-/users/{{id}}/reward method. GET-/users/{{id}}/reward?sort_by=rewardSequence - This method is used to sort the reward based on sequence.

## Fetch the list of all rewards used by a member

 - [GET /users/{{memberId}}/usedreward](https://annexcloud.redocly.app/loyalty/loyalty/rewards/getusedreward.md): Using this method, you can retrieve the details of all rewards that have been used by a specific loyalty member. To access the rewards, you need to pass the unique member ID.

## Debit points from member's account for using a reward

 - [POST /users/{{memberId}}/usedreward](https://annexcloud.redocly.app/loyalty/loyalty/rewards/usedrewardpost.md): This method is used to debit points from the member's account using their ID, used reward ID and code, and the number of points to be debited.

## Fetch the list of all the rewards established in your loyalty program

 - [GET /rewardlist/all](https://annexcloud.redocly.app/loyalty/loyalty/rewards/getrewardsbysite.md): By using this method, all rewards configured against a site ID can be retrieved. Note - The results of this API can also be filtered by passing the page number in the query parameter /rewardlist/all?page=1

## To update reward details

 - [PATCH rewardlistupdate/{{rewardId}}](https://annexcloud.redocly.app/loyalty/loyalty/rewards/patchrewardlistrewardidre.md): This method can be used to update four parameter details - rewardName, overallRewardLimit, creditRequired, and rewardStatus.  Note - To receive a successful response, the request body must include one of the above-mentioned four parameters along with rewardID.