Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Coupon details

get/coupon/get

Query parameters

issuedToIdsinteger

Pass the customer id that you want to retrieve the coupon details from.

codestring required

Pass the coupon code that you want to retrieve. To retrieve details of multiple coupons, pass each code separating with , (comma).

coupon_code_case''

This parameter helps to retrieve the coupon code in the desired letter cases. By default, the system automatically converts the coupon code to upper case. The query itself is not case sensitive. Supported Values: LOWER: Converts the coupon code to lower case. UPPER: Converts the coupon codes to upper case. AS_IT_IS: It ensure that the coupon code is retrieved exactly as it was created or provided, without altering the letter case. For instance, if the code is "abAB123," it should be retrieved and displayed as "abAB123," maintaining its original formatting.

Response

200

OR

Example response

{
  "response": {
    "status": {
      "success": "true",
      "status": "true",
      "code": 200,
      "message": "Success"
    },
    "coupons": {
      "coupon": [
        {
          "id": "1296377532",
          "code": "ZLI0HZ0EGH",
          "valid_till": "09-05-2026",
          "issued_on": "2025-04-30 11:13:36",
          "valid_from": "2025-04-30 11:13:36",
          "series_id": 757291,
          "is_absolute": true,
          "value": 500,
          "customer": {
            "id": "565039504",
            "name": "Tom Sawyer",
            "mobile": "919400488244",
            "email": "tom.sawyer@gmail.com"
          },
          "pincode": "NULL",
          "issued_store": {
            "code": "doc123",
            "name": "DocStore"
          },
          "item_status": {
            "success": "true",
            "code": 700,
            "message": "Coupon processing successful"
          }
        }
      ]
    }
  }
}