List Member's Eligible Rewards API

Time	Status	User Agent
Retrieving recent requests…

start_cursor

int32

Defaults to 0. This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.

count

int32

Defaults to 100. This is a limit on the number of objects to be returned. Count can range between 1 and 1000, and the default is 100.

language

string

Defaults to english

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.

200200

400400