List All Rewards

get

https://api.zinrelo.com/v2/loyalty/rewards

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The API Rate Limiting Category is General API. This API endpoint returns a list of all rewards. By default, the rewards are returned sorted by last_modified_date, with the most recently modified rewards appearing first.

You can pass transaction attributes in List all Rewards 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:
The attribute "eligible_tiers_list" has been deprecated from API response. Any new tiers that are added will not show up in this list.

Query Params

language

string

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

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

Please Note:

200200

400400