Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Redeem single coupon

This API allows you to redeem active coupons of a loyalty customer. You can pass multiple coupons at once.

post/coupon/redeem

Request body

billAmountnumber float required

Transaction amount of the bill.

transactionNumberstring required

Transaction number against which the coupon needs to be redeemed.

codestring required

Coupon code to redeem.

redemptionTimestring date

Date and time of redemption in YYYY-MM-DD HH:MM:SS format. The time defined here is used for certain evaluations, but it is not stored in the system. The system considers the store's current time as the redemption time.

Response

200

Example response

{
  "redemption": [
    {
      "id": 369455787,
      "code": "MGU9Y4PM",
      "discountCode": "NO_VALUE",
      "seriesCode": 12313,
      "isAbsolute": true,
      "couponValue": 10,
      "redemptionStatus": {
        "statusCode": {
          "status": true,
          "message": "Coupon processing successful",
          "code": 700
        },
        "message": "Coupon processing successful",
        "code": 700,
        "success": true
      },
      "discountType": "ABS",
      "discountValue": 10
    }
  ],
  "redemptionStatus": {
    "status": true,
    "message": "Coupon processing successful",
    "code": 700
  },
  "customer": {
    "id": 126080386,
    "profiles": [
      {
        "firstName": "test",
        "lastName": "test",
        "identifiers": [
          {
            "type": "mobile",
            "value": "917500000000"
          }
        ],
        "userId": 126080386,
        "autoUpdateTime": "2021-05-12T15:18:01Z",
        "identifiersAll": [
          {
            "type": "mobile",
            "value": "917500000000"
          }
        ]
      }
    ]
  }
}