Sign in

v1

latestOpenAPI 3.0.22026-07-2645239950.4 KB

Redeem API

post/redeem

Request body

reward_idstring required

Unique ID that identifies a reward in Zinrelo. This is the ID of the reward against which the redemption transaction has to be recorded.

points_to_be_redeemedinteger

REQUIRED: only for flexible redemption. This is the number of points to be redeemed.

{"stackTrail":"components:schemas:redeem-request-body:properties:status","oasType":"schema","type":"unknown","description":"Pass the redemption status—approved or pending. If no entry is passed, the transaction will be redeemed, and its status will be approved.\n<b> Note: This feature is applicable only for Shopify supported stores.<b/>"}

Response

200

successboolean

Example response

{
  "data": {
    "status": "approved",
    "transaction_attributes": {
      "reason": null
    },
    "last_modified_date": "11-Mar-2025 11:27:03",
    "additional_data": {},
    "approved_date": "11-Mar-2025 11:27:03",
    "reward_info": {
      "reward_name": "$10 Gift Certificate Netsuite",
      "points_status": "redeemed",
      "coupon_code": "41EAE010",
      "reward_link": null,
      "reward_id": "reward_bc668",
      "points": 100
    },
    "member_id": "pallavi+095@zinrelo.com",
    "transaction_type": "redeem",
    "id": "67d01e07adb896d71d81ccdb",
    "created_date": "11-Mar-2025 11:27:03"
  },
  "success": true
}