v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Redeem bulk coupons

Lets you redeem one or more coupons of a customer.

post/coupon/bulk/redeem

Request body

codestring

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.

transactionNumberstring

Transaction number for which the coupon(s) needs to be redeemed.

billAmountnumber double required

Transaction amount for which the coupon is redeemed.

Response

200

totalCountinteger
failureCountinteger

Example response

{
  "response": [
    {
      "entityId": 369454015,
      "result": {
        "id": 369454015,
        "code": "U6ER8MJ5",
        "discountCode": "NO_VALUE",
        "seriesCode": 84093,
        "isAbsolute": true,
        "couponValue": 100,
        "redemptionStatus": {
          "statusCode": {
            "status": true,
            "message": "Coupon processing successful",
            "code": 700
          },
          "message": "Coupon processing successful",
          "code": 700,
          "success": true
        },
        "discountType": "ABS",
        "discountValue": 100
      }
    }
  ],
  "totalCount": 1
}