# Rewards V2

The Rewards API serves as a crucial component of modern customer engagement strategies, enabling businesses to effectively manage and distribute rewards to their members. Its primary purpose is to facilitate the retrieval, assignment, and management of various rewards, which can significantly enhance user experience and drive customer loyalty. By providing a seamless integration with Reward systems, this API allows organizations to offer personalized incentives that cater to individual preferences and behaviors.

Key features of the Rewards API include the ability to list rewards based on specific criteria, retrieve detailed information about each reward, and assign rewards to members with ease. The API supports various data types and parameters for filtering rewards, ensuring that businesses can tailor their offerings to meet the unique needs of their customer base. Furthermore, the API includes robust error handling and validation mechanisms, which help maintain data integrity and improve overall system performance.

In the broader context of a rewards system, the Rewards API plays a pivotal role in fostering customer engagement. Rewards not only incentivize purchases but also encourage repeat interactions with the brand. By leveraging the capabilities of this API, businesses can create dynamic reward programs that resonate with members, thereby increasing customer satisfaction and retention. The ability to offer personalized rewards enhances the relevance of marketing efforts and strengthens the emotional connection between the brand and its customers, ultimately leading to higher conversion rates and improved brand loyalty. 

## Retrieve a list of all rewards

 - [GET /rewards](https://annexcloud.redocly.app/loyalty/loyalty/rewards-v2/getrewards.md): This endpoint retrieves a list of all available rewards. It allows businesses to filter rewards based on various parameters such as type, status, and issuance source type. The response includes metadata about the rewards, such as pagination information and total counts, making it easier for applications to manage large datasets.

## Upload the coupon codes to an active reward

 - [POST /rewards/{{reward_id}}/coupons](https://annexcloud.redocly.app/loyalty/loyalty/rewards-v2/rewardrewardidcoupon.md): This method uploads one or more coupon codes to the specified active reward. It supports bulk uploads of up to 2,000 codes per request. The system validates each code and returns the overall upload status.

## Get details of a specific reward

 - [GET /rewards/{{reward_id}}](https://annexcloud.redocly.app/loyalty/loyalty/rewards-v2/getrewardsrewardid.md): By specifying a unique reward ID, this endpoint provides detailed information about a particular reward. This includes attributes like name, type, status, and redemption data. Businesses can use this information to display or manage specific rewards within their applications, ensuring members have access to the most relevant details.

## Retrieve list of eligible rewards for a member

 - [GET /users/{{member_id}}/rewards](https://annexcloud.redocly.app/loyalty/loyalty/rewards-v2/getusersmemberidrewards.md): This endpoint retrieves a list of rewards associated with a specific user, identified by the member ID. The response includes reward details, eligibility information, and pagination metadata. This endpoint checks and retrieves the eligibility status of rewards for a specific member, identified by their member ID. It determines whether the member qualifies for any available rewards based on predefined criteria such as past transactions, membership status, or other eligibility rules If no rewards are available, the response will indicate ineligibility.

## Retrieve history of redeemed rewards for a member

 - [GET /users/{{member_id}}/rewards/history](https://annexcloud.redocly.app/loyalty/loyalty/rewards-v2/getusersmemberidrewardshistory.md): This endpoint allows you to retrieve and filter rewards associated with a specific member identified by their Member ID. This endpoint retrieves a detailed history of all rewards that the member has previously redeemed. Using the provided member ID, it returns a list of rewards the member has utilized, including details such as reward names, redemption dates, usage status, and any associated metadata. This allows tracking of past reward usage and helps administrators monitor reward consumption over time. This endpoint supports various query parameters to refine the response and provide more precise data.

## Assign a reward to member

 - [POST /rewards/{{reward_id}}/users/{{member_id}}/assign](https://annexcloud.redocly.app/loyalty/loyalty/rewards-v2/postassignreward.md): This endpoint is used to assign a reward to a specific member. It requires both the reward ID and member ID, along with details about the assignment, such as the source type. Successful assignments enable businesses to track which rewards have been issued and manage member benefits effectively.

## Update data against the reward awarded to member

 - [PATCH /rewards/{{reward_id}}/users/{{member_id}}/assign](https://annexcloud.redocly.app/loyalty/loyalty/rewards-v2/patchrewardsassign.md): This endpoint updates the details of a reward awarded to a specific member. It requires assign ID, reward ID and member ID, along with relevant assignment details such as the source type and collected data. This ensures businesses can track issued rewards and manage member benefits effectively.