v1

latestOpenAPI 3.0.22026-07-2645239950.4 KB

EUD Guest Rewards API

get/rewards

Query parameters

start_cursorinteger

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.

countinteger

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.

languagestring

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

sort_bystring

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.

Response

200

totalinteger

The total number of eligible rewards.

next_cursorinteger

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.

moreboolean

Example response

{
  "total": 3,
  "rewards": [
    {
      "reward_name": "$10 Gift Certificate Netsuite",
      "enduser_reward_confirmation_html": "<b>{{POINTS}} Points</b> WILL be deducted from your account balance. Do you wish to redeem this reward?",
      "reward_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png",
      "implementation_type": "coupon_code",
      "reward_value": "5",
      "last_modified_date": "07/07/2023 10:49:41",
      "reward_sub_type": "Fixed Amount Discount",
      "created_date": "03/15/2021 12:59:39",
      "enduser_reward_short_description": "For {{POINTS}} points",
      "points_to_be_redeemed": 500,
      "reward_type": "Coupon Based Rewards",
      "enduser_reward_post_confirmation_html": "Here is your coupon code.",
      "id": "604f5a3b8152252216f5c1ad",
      "reward_id": "reward_bc668",
      "metadata": {
        "Category": "Limited time",
        "Brand": "Nescafe"
      }
    },
    {
      "reward_name": "$10 OFF COUPON Miva",
      "enduser_reward_confirmation_html": "<b>{{POINTS}} Points</b> WILL be deducted from your account balance. Do you wish to redeem this reward?",
      "reward_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png",
      "implementation_type": "coupon_code",
      "reward_value": "10",
      "last_modified_date": "07/07/2023 10:49:43",
      "reward_sub_type": "Fixed Amount Discount",
      "created_date": "03/15/2021 12:59:41",
      "enduser_reward_short_description": "For {{POINTS}} points",
      "points_to_be_redeemed": 1000,
      "reward_type": "Coupon Based Rewards",
      "enduser_reward_post_confirmation_html": "Here is your coupon code.",
      "rank": 1,
      "id": "604f5a3d8152252216f5c1b0",
      "reward_id": "reward_a1e91",
      "metadata": {
        "Category": "Miva",
        "Brand": "Nescafe",
        "Products Eligible": "A,B,C"
      }
    },
    {
      "reward_name": "$15 OFF COUPON",
      "enduser_reward_confirmation_html": "<b>{{POINTS}} Points</b> WILL be deducted from your account balance. Do you wish to redeem this reward?",
      "reward_card_background_image_url": "",
      "implementation_type": "coupon_code",
      "reward_value": "10",
      "last_modified_date": "07/06/2023 05:20:05",
      "reward_sub_type": "Percentage Discount",
      "created_date": "03/15/2021 12:59:42",
      "enduser_reward_short_description": "For {{POINTS}} points",
      "points_to_be_redeemed": 1400,
      "reward_type": "Coupon Based Rewards",
      "enduser_reward_post_confirmation_html": "Here is your coupon code.",
      "rank": 1,
      "id": "604f5a3e8152252216f5c1b3",
      "reward_id": "reward_9c350",
      "metadata": {}
    }
  ],
  "next_cursor": 100,
  "more": false
}