v1
latestOpenAPI 3.0.12026-07-24501176.6 MBGet All Customer Coupons
Query parameters
Mobile number of the customer.
Email ID of the customer.
External ID of the customer.
Unique ID of the customer.
Get coupons of selected status(es). In the enum values, Active_Redeemed is for coupon is active but redeemed), Active_Unredeemed for coupons that are active and not redeemed, Expired_Redeemed for coupons that are expired but redeemed,and Expired_Unredeemed for coupons that are expired and not redeemed.
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
Example response
{
"entity": {
"pagination": {
"limit": "100",
"offset": "0",
"total": 99
},
"customers": [
{
"firstname": "Abijith",
"lastname": "Gupta",
"mobile": "11223569865",
"id": 555567088,
"coupons": [
{
"code": "0355325315",
"seriesId": 415446,
"description": " 500AED Voucher ",
"validTill": "2025-10-31T00:00:00Z",
"discountType": "ABS",
"discountValue": 500,
"redemptionsLeft": 1,
"id": 1293400633,
"createdDate": "2025-04-14T16:58:45Z",
"transactionNumber": "0",
"issuedAt": {
"code": "1234576",
"name": "Dallas DICK'S Sporting Goods"
},
"customProperty": [
{
"name": "standard_image_1"
}
]
}
]
}
]
},
"success": true
}