Get Eligible Rewards with Member ID

get

https://api.zinrelo.com/v2/loyalty/members/{member_id}/rewards

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The API Rate Limiting Category is Member Eligibility API. This API endpoint returns a list of all the rewards a member is eligible for. The ‘idParam’ parameter specifies that the identifier being passed in the ID field of this REST URL is member_id.

You can pass transaction attributes in Get Eligible Rewards with Member ID API to filter rewards based on transaction attributes. By leveraging this functionality, you can manage and retrieve rewards that are most relevant to your needs. To know more, click here.

Please Note: Rewards will not be displayed for users who have opted out.

📘
This is the latest version of the Get Eligible Rewards API. If you are still using the older version, click here.

📘
Please Note:
The attribute "eligible_tiers_list" has been deprecated from API response. Any new tiers that are added will not show up in this list.

Path Params

member_id

string

required

Defaults to [email protected]

Enter the member ID.

Query Params

idParam

string

required

Defaults to member_id

Enter 'member_id' as idParam.

langauge

string

One of the store languages, for example english/ italian/ german, etc.

ignore_allowed_redeem_points

boolean

Pass "true" in this parameter if you want ineligible rewards to be visible as well. By default, it is "false."

sort_by

string

The response will contain the rewards ordered by the rank configured in the Zinrelo admin console. You can sort the sequence using the following options: "rank", "-rank", "points_to_be_redeemed", or "-points_to_be_redeemed". Additionally, you can combine sorting options, such as "-rank,points_to_be_redeemed", "-rank,-points_to_be_redeemed", "rank,points_to_be_redeemed", or "rank,-points_to_be_redeemed".

"-" signifies the latest reward first.

Note: If no sorting option is specified, the response will default to the saved rank, which is "rank,points_to_be_redeemed".

In scenarios where the rank of rewards is same, sorting will be based on a second parameter. For example, in "rank,points_to_be_redeemed," if the ranks are identical, the sorting will then be determined by the points to be redeemed parameter.

Responses

This is the latest version of the Get Eligible Rewards API. If you are still using the older version, click here.

Please Note:

200200

400400