get https://{host}/v2/customers//coupons
This API provides detailed information about customer coupons, including each coupon’s unique code, discount value, expiry date, redemption status, and related campaign details. It also covers specific conditions, such as redemption limits, eligibility criteria, and applicable stores. This API is useful for obtaining in-depth data about each coupon and understanding its terms, usage history, and redemption rules.
Note
For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call.
Prerequisites
- Authentication: Basic or OAuth authentication
- Default access group
Resource information
URL | /customers[customerId]/coupons |
HTTP Method | GET |
Pagination | No |
Batch support | No |
Rate limit information | None |
API endpoint example
https://eu.api.capillarytech.com/v2/customers/565032176/coupons
curl --location 'https://eu.api.capillarytech.com/v2/customers/565032176/coupons' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic c2FudC5wXzEyMzpiMmVhMGFhYWI1ZThmODg5ZTAzNGE2NjA5NTIwM2FlNw==' \
--header 'Cookie: _cfuvid=tpKykcaB8j092CRnB66wUikOsgeMsTbQIAona20jx1M-1728643546352-0.0.1.1-604800000; _cfuvid=m2yUAqOA0jRHLfltVaqsrBoJp6yyOUuCAyw4QyAJ0uw-1751016550935-0.0.1.1-604800000'
Request path parameters
Parameters | Data Type | Description |
---|---|---|
customerId | Integer | Unique ID of the customer to fetch coupon details. |
Request query parameters
Parameters | Data Type | Description |
---|---|---|
coupon_code_case | Enum | 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 , UPPER , AS_IT_IS . |
Response Parameters
Coupon Entity
Parameter | Type | Description |
---|---|---|
id | Integer | Unique coupon ID. |
seriesId | Integer | ID of the associated coupon series. |
series | Object | Series details |
code | String | Unique coupon code (e.g., "QZX30JQLIC" ). |
description | String | Coupon description. |
createdDate | String (ISO) | Creation timestamp. |
validTill | String (ISO) | Expiry timestamp. YYYY-MM-DDTHH:MM:SSZ |
issuedTo | Integer | Recipient user ID. |
issuedBy | Integer | Issuer user ID. |
orgId | Integer | Organization ID. |
refId | Integer | Reference ID (0 if none). |
issuedAt | Object | Issuing location |
status | Object | Operation status |
couponDiscountType | String | Discount type (e.g., "ABS" ). |
issuedOn | String (ISO) | Issuance timestamp. YYYY-MM-DDTHH:MM:SSZ |
activeFrom | String (ISO) | Activation timestamp. YYYY-MM-DDTHH:MM:SSZ |
redemptionsLeft | Integer | Remaining redemptions (e.g., 4 ). |
couponStatus | Object | Coupon status (mirrors status ). |
redemptionInfo | Array | Redemption history |
reversedRedemptionInfo | Array | Reversed redemptions |
discountType | Boolean | Deprecated: Use couponDiscountType . |
discountValue | Integer | Discount amount (e.g., 1000 ). |
discountValueAsDouble | Double | Discount value in double format. |
discountUpto | Integer | Maximum discount cap (0 for no cap). |
trimmedCode | String | Shortened coupon code. |
seriesName | String | Name of the coupon series. |
redeemed | Boolean | Indicates redemption status: true = coupon has been redeemed, false = coupon is not redeemed |
Series Object (entity[].series
)
entity[].series
)Parameter | Type | Description |
---|---|---|
id | Integer | Series ID. |
orgId | Integer | Organization ID. |
description | String | Series description. |
discountCode | String | Discount code (e.g., "uatMaySant" ). |
validTillDate | String (ISO) | Series expiry timestamp. YYYY-MM-DDTHH:MM:SSZ |
validDaysFromCreation | Integer | Validity duration in days. |
expiryStrategyValue | Integer | Expiry strategy code. |
maxCreate | Integer | Maximum issuable coupons (e.g., 20 ). |
maxRedeem | Integer | Maximum redemptions (e.g., 20 ). |
isTransferrable | Boolean | false if non-transferable. |
anyUser | Boolean | true if redeemable by any user. |
sameUserMultipleRedeem | Boolean | true if user can redeem multiple times. |
isReferralExistingUsersAllowed | Boolean | false to block referrals for existing users. |
isMultipleUseAllowed | Boolean | true if multi-use allowed. |
isValidationRequired | Boolean | false if no validation needed. |
isValidWithDiscountedItem | Boolean | true if valid on discounted items. |
createdBy | Integer | Creator user ID. |
numIssued | Integer | Number of coupons issued. |
numRedeemed | Integer | Number of coupons redeemed. |
createdOn | String (ISO) | Series creation timestamp. YYYY-MM-DDTHH:MM:SSZ |
lastUsed | String (ISO) | Last redemption timestamp. YYYY-MM-DDTHH:MM:SSZ |
seriesCode | String | Internal series code. |
smsTemplate | String | SMS notification template. |
isSMSDisabled | Boolean | false if SMS enabled. |
isUpdateProductData | Boolean | false if product updates disabled. |
info | String | Additional series info. |
isMultipleVouchersPerUserAllowed | Boolean | true if users can hold multiple vouchers. |
doNotResendExistingVoucher | Boolean | true to avoid resending existing vouchers. |
mutualExclusiveSeriesIds | String | JSON array of exclusive series IDs. |
storeIdsJson | String | JSON array of valid store IDs. |
isDvsEnabled | Boolean | false if Dynamic Voucher System (DVS) is disabled. |
dvsExpiryDate | String (ISO) | DVS expiry timestamp. |
priority | Integer | Priority level (e.g., 0 ). |
shortSMSTemplate | String | Concise SMS template. |
maxVouchersPerUser | Integer | Max vouchers per user (e.g., 5 ). |
minDaysBetweenVouchers | Integer | Minimum days between issuing vouchers. |
maxReferralsPerReferee | Integer | Max referrals per user (-1 for unlimited). |
discountUpto | Integer | Discount cap (0 for no cap). |
discountValue | Integer | Discount amount (e.g., 1000 ). |
dvsItems | String | DVS-specific items. |
redemptionRange | String | JSON for redemption constraints. |
minBillAmount | Integer | Minimum bill amount to redeem (e.g., 100 ). |
maxBillAmount | Integer | Maximum bill amount to redeem (e.g., 20000 ). |
redeemAtStore | String | JSON array of redemption store IDs. |
campaignId | Integer | Associated campaign ID (-1 if none). |
tag | String | Series tag. |
maxRedemptionsInSeriesPerUser | Integer | Max redemptions per user (e.g., 4 ). |
minDaysBetweenRedemption | Integer | Minimum days between redemptions. |
redemptionValidFrom | String (ISO) | Earliest redemption timestamp. YYYY-MM-DDTHH:MM:SSZ |
sourceOrgId | Integer | Source organization ID (-1 if none). |
issueToLoyalty | Boolean | false if not issued via loyalty program. |
redeemStoreType | String | Redemption store type. |
offlineRedeemType | Boolean | false if online-only redemption. |
isOldFlowEnabled | Boolean | false if legacy flow disabled. |
isPreRedeemEventRequired | Boolean | false if no pre-redemption event needed. |
brands | Array | Allowed brands (empty for all). |
products | Array | Allowed products (empty for all). |
categories | Array | Allowed categories (empty for all). |
termsAndConditions | String | Terms and conditions text. |
signalRedemptionEvent | Boolean | false if no event signaling needed. |
syncToClient | Boolean | false if no client sync required. |
showPinCode | Boolean | false if PIN not required. |
redemptionPerCouponMaxLimit | Integer | Max redemptions per coupon (-1 for unlimited). |
validRedemptionOrgEntityDetails | Object | Valid redemption entities (see below). |
seriesType | String | Series type (e.g., "UNDEFINED" ). |
clientHandlingType | String | Client handling type (e.g., "DISC_CODE" ). |
expiryStrategyType | String | Expiry strategy (e.g., "SERIES_EXPIRY" ). |
discountOn | String | Discount applicability (e.g., "BILL" ). |
discountType | String | Discount type (e.g., "ABS" ). |
dvsExpiryDateFormat | String | DVS expiry date in YYYY-MM-DD . |
updateProductData | Boolean | false if product updates disabled. |
entityLevelRedemptionConfigsValues | Array | Additional redemption configs (empty). |
redemptionValidFromFormat | String | Redemption start date in YYYY-MM-DD . |
validTilldateFormat | String | Series expiry date in YYYY-MM-DD . |
IssuedAt Object
Parameter | Type | Description |
---|---|---|
id | Integer | Location ID (e.g., 75152715 ). |
code | String | Location code (e.g., "doc123" ). |
description | String | Location description (empty). |
name | String | Location name (e.g., "DocStore" ). |
type | String | Location type (e.g., "STORE" ). |
adminType | String | Admin type (e.g., "GENERAL" ). |
isOrgUnit | Boolean | false if not an org unit. |
Status Object
Parameter | Type | Description |
---|---|---|
statusCode | Object | Status details (see below). |
statusCode.status | Boolean | true if successful. |
statusCode.code | Integer | Status code |
statusCode.message | String | Status message (e.g., "Coupon Resent" ). |
warnings | Array | Warnings (empty). |
warningsAsStatusCode | Array | Warnings in status format (empty). |
code | Integer | Duplicate of statusCode.code . |
success | Boolean | Duplicate of statusCode.status . |
message | String | Duplicate of statusCode.message . |
Example response
{
"entity": [
{
"id": 1298282420,
"seriesId": 775657,
"series": {
"id": 775657,
"orgId": 100737,
"description": "Coupon Series for UAT May Sant",
"discountCode": "uatMaySant",
"validTillDate": "2025-05-29T00:00:00Z",
"validDaysFromCreation": 30,
"expiryStrategyValue": 1,
"maxCreate": 20,
"maxRedeem": 20,
"isTransferrable": false,
"anyUser": true,
"sameUserMultipleRedeem": true,
"isReferralExistingUsersAllowed": false,
"isMultipleUseAllowed": true,
"isValidationRequired": false,
"isValidWithDiscountedItem": true,
"createdBy": 75155297,
"numIssued": 0,
"numRedeemed": 0,
"createdOn": "2025-05-21T07:12:09Z",
"lastUsed": "2025-05-21T07:12:09Z",
"seriesCode": "0AAB21DFA86D4956BBD7",
"smsTemplate": "Hi {{first_name}} {{last_name}} your voucher code {{voucher}}is valid {{valid_days_from_create}}. {{fullname}} {{offer_name}}",
"isSMSDisabled": false,
"isUpdateProductData": false,
"info": "UAT May Coupon Series",
"isMultipleVouchersPerUserAllowed": true,
"doNotResendExistingVoucher": true,
"mutualExclusiveSeriesIds": "[-1]",
"storeIdsJson": "[-1]",
"isDvsEnabled": false,
"dvsExpiryDate": "2025-05-21T00:00:00Z",
"priority": 0,
"shortSMSTemplate": "Hello {{cust_name}}, your voucher code is {{voucher_code}}",
"maxVouchersPerUser": 5,
"minDaysBetweenVouchers": 0,
"maxReferralsPerReferee": -1,
"discountUpto": 0,
"discountValue": 1000,
"dvsItems": "items",
"redemptionRange": "{\"dom\" : [-1], \"dow\": [-1], \"hours\": [-1]}",
"minBillAmount": 100,
"maxBillAmount": 20000,
"redeemAtStore": "[-1]",
"campaignId": -1,
"tag": "Coupon Series for UAT May Sant",
"maxRedemptionsInSeriesPerUser": 4,
"minDaysBetweenRedemption": 0,
"redemptionValidFrom": "2025-04-26T00:00:00Z",
"sourceOrgId": -1,
"issueToLoyalty": false,
"redeemStoreType": "redeemable_stores",
"offlineRedeemType": false,
"isOldFlowEnabled": false,
"isPreRedeemEventRequired": false,
"brands": [],
"products": [],
"categories": [],
"termsAndConditions": "T&C",
"signalRedemptionEvent": false,
"syncToClient": false,
"showPinCode": false,
"redemptionPerCouponMaxLimit": -1,
"validRedemptionOrgEntityDetails": {
"concepts": [],
"zones": [],
"stores": [],
"tills": []
},
"seriesType": "UNDEFINED",
"clientHandlingType": "DISC_CODE",
"expiryStrategyType": "SERIES_EXPIRY",
"discountOn": "BILL",
"discountType": "ABS",
"dvsExpiryDateFormat": "2025-05-21",
"updateProductData": false,
"entityLevelRedemptionConfigsValues": [],
"redemptionValidFromFormat": "2025-04-26",
"validTilldateFormat": "2025-05-29"
},
"code": "QZX30JQLIC",
"description": "Coupon Series for UAT May Sant",
"createdDate": "2025-05-21T12:43:01Z",
"validTill": "2025-05-29T23:59:59Z",
"isRedeemed": false,
"issuedTo": 565032176,
"issuedBy": 75155297,
"orgId": 100737,
"refId": 0,
"issuedAt": {
"id": 75152715,
"code": "doc123",
"description": "",
"name": "DocStore",
"type": "STORE",
"adminType": "GENERAL",
"isOrgUnit": false
},
"status": {
"statusCode": {
"status": true,
"code": 700,
"message": "Coupon Resent"
},
"warnings": [],
"warningsAsStatusCode": [],
"code": 700,
"success": true,
"message": "Coupon Resent"
},
"couponDiscountType": "ABS",
"issuedOn": "2025-05-21T12:43:01Z",
"activeFrom": "2025-05-21T12:43:01Z",
"redemptionsLeft": 4,
"couponStatus": {
"statusCode": {
"status": true,
"code": 200,
"message": "Success"
},
"warnings": [],
"warningsAsStatusCode": [],
"code": 200,
"success": true,
"message": "Success"
},
"redemptionInfo": [],
"reversedRedemptionInfo": [],
"discountType": true,
"discountValue": 1000,
"discountValueAsDouble": 1000.0,
"discountUpto": 0,
"trimmedCode": "QZX30JQLIC",
"seriesName": "Coupon Series for UAT May Sant",
"redeemed": false
},
{
"id": 1298282419,
"seriesId": 775657,
"series": {
"id": 775657,
"orgId": 100737,
"description": "Coupon Series for UAT May Sant",
"discountCode": "uatMaySant",
"validTillDate": "2025-05-29T00:00:00Z",
"validDaysFromCreation": 30,
"expiryStrategyValue": 1,
"maxCreate": 20,
"maxRedeem": 20,
"isTransferrable": false,
"anyUser": true,
"sameUserMultipleRedeem": true,
"isReferralExistingUsersAllowed": false,
"isMultipleUseAllowed": true,
"isValidationRequired": false,
"isValidWithDiscountedItem": true,
"createdBy": 75155297,
"numIssued": 0,
"numRedeemed": 0,
"createdOn": "2025-05-21T07:12:09Z",
"lastUsed": "2025-05-21T07:12:09Z",
"seriesCode": "0AAB21DFA86D4956BBD7",
"smsTemplate": "Hi {{first_name}} {{last_name}} your voucher code {{voucher}}is valid {{valid_days_from_create}}. {{fullname}} {{offer_name}}",
"isSMSDisabled": false,
"isUpdateProductData": false,
"info": "UAT May Coupon Series",
"isMultipleVouchersPerUserAllowed": true,
"doNotResendExistingVoucher": true,
"mutualExclusiveSeriesIds": "[-1]",
"storeIdsJson": "[-1]",
"isDvsEnabled": false,
"dvsExpiryDate": "2025-05-21T00:00:00Z",
"priority": 0,
"shortSMSTemplate": "Hello {{cust_name}}, your voucher code is {{voucher_code}}",
"maxVouchersPerUser": 5,
"minDaysBetweenVouchers": 0,
"maxReferralsPerReferee": -1,
"discountUpto": 0,
"discountValue": 1000,
"dvsItems": "items",
"redemptionRange": "{\"dom\" : [-1], \"dow\": [-1], \"hours\": [-1]}",
"minBillAmount": 100,
"maxBillAmount": 20000,
"redeemAtStore": "[-1]",
"campaignId": -1,
"tag": "Coupon Series for UAT May Sant",
"maxRedemptionsInSeriesPerUser": 4,
"minDaysBetweenRedemption": 0,
"redemptionValidFrom": "2025-04-26T00:00:00Z",
"sourceOrgId": -1,
"issueToLoyalty": false,
"redeemStoreType": "redeemable_stores",
"offlineRedeemType": false,
"isOldFlowEnabled": false,
"isPreRedeemEventRequired": false,
"brands": [],
"products": [],
"categories": [],
"termsAndConditions": "T&C",
"signalRedemptionEvent": false,
"syncToClient": false,
"showPinCode": false,
"redemptionPerCouponMaxLimit": -1,
"validRedemptionOrgEntityDetails": {
"concepts": [],
"zones": [],
"stores": [],
"tills": []
},
"seriesType": "UNDEFINED",
"clientHandlingType": "DISC_CODE",
"expiryStrategyType": "SERIES_EXPIRY",
"discountOn": "BILL",
"discountType": "ABS",
"dvsExpiryDateFormat": "2025-05-21",
"updateProductData": false,
"entityLevelRedemptionConfigsValues": [],
"redemptionValidFromFormat": "2025-04-26",
"validTilldateFormat": "2025-05-29"
},
"code": "GIJSGIZA3P",
"description": "Coupon Series for UAT May Sant",
"createdDate": "2025-05-21T12:42:59Z",
"validTill": "2025-05-29T23:59:59Z",
"isRedeemed": false,
"issuedTo": 565032176,
"issuedBy": 75155297,
"orgId": 100737,
"refId": 0,
"issuedAt": {
"id": 75152715,
"code": "doc123",
"description": "",
"name": "DocStore",
"type": "STORE",
"adminType": "GENERAL",
"isOrgUnit": false
},
"status": {
"statusCode": {
"status": true,
"code": 700,
"message": "Coupon Resent"
},
"warnings": [],
"warningsAsStatusCode": [],
"code": 700,
"success": true,
"message": "Coupon Resent"
},
"couponDiscountType": "ABS",
"issuedOn": "2025-05-21T12:42:59Z",
"activeFrom": "2025-05-21T12:42:59Z",
"redemptionsLeft": 4,
"couponStatus": {
"statusCode": {
"status": true,
"code": 200,
"message": "Success"
},
"warnings": [],
"warningsAsStatusCode": [],
"code": 200,
"success": true,
"message": "Success"
},
"redemptionInfo": [],
"reversedRedemptionInfo": [],
"discountType": true,
"discountValue": 1000,
"discountValueAsDouble": 1000.0,
"discountUpto": 0,
"trimmedCode": "GIJSGIZA3P",
"seriesName": "Coupon Series for UAT May Sant",
"redeemed": false
},
{
"id": 1298282418,
"seriesId": 775657,
"series": {
"id": 775657,
"orgId": 100737,
"description": "Coupon Series for UAT May Sant",
"discountCode": "uatMaySant",
"validTillDate": "2025-05-29T00:00:00Z",
"validDaysFromCreation": 30,
"expiryStrategyValue": 1,
"maxCreate": 20,
"maxRedeem": 20,
"isTransferrable": false,
"anyUser": true,
"sameUserMultipleRedeem": true,
"isReferralExistingUsersAllowed": false,
"isMultipleUseAllowed": true,
"isValidationRequired": false,
"isValidWithDiscountedItem": true,
"createdBy": 75155297,
"numIssued": 0,
"numRedeemed": 0,
"createdOn": "2025-05-21T07:12:09Z",
"lastUsed": "2025-05-21T07:12:09Z",
"seriesCode": "0AAB21DFA86D4956BBD7",
"smsTemplate": "Hi {{first_name}} {{last_name}} your voucher code {{voucher}}is valid {{valid_days_from_create}}. {{fullname}} {{offer_name}}",
"isSMSDisabled": false,
"isUpdateProductData": false,
"info": "UAT May Coupon Series",
"isMultipleVouchersPerUserAllowed": true,
"doNotResendExistingVoucher": true,
"mutualExclusiveSeriesIds": "[-1]",
"storeIdsJson": "[-1]",
"isDvsEnabled": false,
"dvsExpiryDate": "2025-05-21T00:00:00Z",
"priority": 0,
"shortSMSTemplate": "Hello {{cust_name}}, your voucher code is {{voucher_code}}",
"maxVouchersPerUser": 5,
"minDaysBetweenVouchers": 0,
"maxReferralsPerReferee": -1,
"discountUpto": 0,
"discountValue": 1000,
"dvsItems": "items",
"redemptionRange": "{\"dom\" : [-1], \"dow\": [-1], \"hours\": [-1]}",
"minBillAmount": 100,
"maxBillAmount": 20000,
"redeemAtStore": "[-1]",
"campaignId": -1,
"tag": "Coupon Series for UAT May Sant",
"maxRedemptionsInSeriesPerUser": 4,
"minDaysBetweenRedemption": 0,
"redemptionValidFrom": "2025-04-26T00:00:00Z",
"sourceOrgId": -1,
"issueToLoyalty": false,
"redeemStoreType": "redeemable_stores",
"offlineRedeemType": false,
"isOldFlowEnabled": false,
"isPreRedeemEventRequired": false,
"brands": [],
"products": [],
"categories": [],
"termsAndConditions": "T&C",
"signalRedemptionEvent": false,
"syncToClient": false,
"showPinCode": false,
"redemptionPerCouponMaxLimit": -1,
"validRedemptionOrgEntityDetails": {
"concepts": [],
"zones": [],
"stores": [],
"tills": []
},
"seriesType": "UNDEFINED",
"clientHandlingType": "DISC_CODE",
"expiryStrategyType": "SERIES_EXPIRY",
"discountOn": "BILL",
"discountType": "ABS",
"dvsExpiryDateFormat": "2025-05-21",
"updateProductData": false,
"entityLevelRedemptionConfigsValues": [],
"redemptionValidFromFormat": "2025-04-26",
"validTilldateFormat": "2025-05-29"
},
"code": "W9Z584RUW6",
"description": "Coupon Series for UAT May Sant",
"createdDate": "2025-05-21T12:42:58Z",
"validTill": "2025-05-29T23:59:59Z",
"isRedeemed": false,
"issuedTo": 565032176,
"issuedBy": 75155297,
"orgId": 100737,
"refId": 0,
"issuedAt": {
"id": 75152715,
"code": "doc123",
"description": "",
"name": "DocStore",
"type": "STORE",
"adminType": "GENERAL",
"isOrgUnit": false
},
"status": {
"statusCode": {
"status": true,
"code": 700,
"message": "Coupon Resent"
},
"warnings": [],
"warningsAsStatusCode": [],
"code": 700,
"success": true,
"message": "Coupon Resent"
},
"couponDiscountType": "ABS",
"issuedOn": "2025-05-21T12:42:58Z",
"activeFrom": "2025-05-21T12:42:58Z",
"redemptionsLeft": 4,
"couponStatus": {
"statusCode": {
"status": true,
"code": 200,
"message": "Success"
},
"warnings": [],
"warningsAsStatusCode": [],
"code": 200,
"success": true,
"message": "Success"
},
"redemptionInfo": [],
"reversedRedemptionInfo": [],
"discountType": true,
"discountValue": 1000,
"discountValueAsDouble": 1000.0,
"discountUpto": 0,
"trimmedCode": "W9Z584RUW6",
"seriesName": "Coupon Series for UAT May Sant",
"redeemed": false
},
{
"id": 1298282415,
"seriesId": 775657,
"series": {
"id": 775657,
"orgId": 100737,
"description": "Coupon Series for UAT May Sant",
"discountCode": "uatMaySant",
"validTillDate": "2025-05-29T00:00:00Z",
"validDaysFromCreation": 30,
"expiryStrategyValue": 1,
"maxCreate": 20,
"maxRedeem": 20,
"isTransferrable": false,
"anyUser": true,
"sameUserMultipleRedeem": true,
"isReferralExistingUsersAllowed": false,
"isMultipleUseAllowed": true,
"isValidationRequired": false,
"isValidWithDiscountedItem": true,
"createdBy": 75155297,
"numIssued": 0,
"numRedeemed": 0,
"createdOn": "2025-05-21T07:12:09Z",
"lastUsed": "2025-05-21T07:12:09Z",
"seriesCode": "0AAB21DFA86D4956BBD7",
"smsTemplate": "Hi {{first_name}} {{last_name}} your voucher code {{voucher}}is valid {{valid_days_from_create}}. {{fullname}} {{offer_name}}",
"isSMSDisabled": false,
"isUpdateProductData": false,
"info": "UAT May Coupon Series",
"isMultipleVouchersPerUserAllowed": true,
"doNotResendExistingVoucher": true,
"mutualExclusiveSeriesIds": "[-1]",
"storeIdsJson": "[-1]",
"isDvsEnabled": false,
"dvsExpiryDate": "2025-05-21T00:00:00Z",
"priority": 0,
"shortSMSTemplate": "Hello {{cust_name}}, your voucher code is {{voucher_code}}",
"maxVouchersPerUser": 5,
"minDaysBetweenVouchers": 0,
"maxReferralsPerReferee": -1,
"discountUpto": 0,
"discountValue": 1000,
"dvsItems": "items",
"redemptionRange": "{\"dom\" : [-1], \"dow\": [-1], \"hours\": [-1]}",
"minBillAmount": 100,
"maxBillAmount": 20000,
"redeemAtStore": "[-1]",
"campaignId": -1,
"tag": "Coupon Series for UAT May Sant",
"maxRedemptionsInSeriesPerUser": 4,
"minDaysBetweenRedemption": 0,
"redemptionValidFrom": "2025-04-26T00:00:00Z",
"sourceOrgId": -1,
"issueToLoyalty": false,
"redeemStoreType": "redeemable_stores",
"offlineRedeemType": false,
"isOldFlowEnabled": false,
"isPreRedeemEventRequired": false,
"brands": [],
"products": [],
"categories": [],
"termsAndConditions": "T&C",
"signalRedemptionEvent": false,
"syncToClient": false,
"showPinCode": false,
"redemptionPerCouponMaxLimit": -1,
"validRedemptionOrgEntityDetails": {
"concepts": [],
"zones": [],
"stores": [],
"tills": []
},
"seriesType": "UNDEFINED",
"clientHandlingType": "DISC_CODE",
"expiryStrategyType": "SERIES_EXPIRY",
"discountOn": "BILL",
"discountType": "ABS",
"dvsExpiryDateFormat": "2025-05-21",
"updateProductData": false,
"entityLevelRedemptionConfigsValues": [],
"redemptionValidFromFormat": "2025-04-26",
"validTilldateFormat": "2025-05-29"
},
"code": "7BU2JOYZZR",
"description": "Coupon Series for UAT May Sant",
"createdDate": "2025-05-21T12:42:51Z",
"validTill": "2025-05-29T23:59:59Z",
"isRedeemed": false,
"issuedTo": 565032176,
"issuedBy": 75155297,
"orgId": 100737,
"refId": 0,
"issuedAt": {
"id": 75152715,
"code": "doc123",
"description": "",
"name": "DocStore",
"type": "STORE",
"adminType": "GENERAL",
"isOrgUnit": false
},
"status": {
"statusCode": {
"status": true,
"code": 700,
"message": "Coupon Resent"
},
"warnings": [],
"warningsAsStatusCode": [],
"code": 700,
"success": true,
"message": "Coupon Resent"
},
"couponDiscountType": "ABS",
"issuedOn": "2025-05-21T12:42:51Z",
"activeFrom": "2025-05-21T12:42:51Z",
"redemptionsLeft": 4,
"couponStatus": {
"statusCode": {
"status": true,
"code": 200,
"message": "Success"
},
"warnings": [],
"warningsAsStatusCode": [],
"code": 200,
"success": true,
"message": "Success"
},
"redemptionInfo": [],
"reversedRedemptionInfo": [],
"discountType": true,
"discountValue": 1000,
"discountValueAsDouble": 1000.0,
"discountUpto": 0,
"trimmedCode": "7BU2JOYZZR",
"seriesName": "Coupon Series for UAT May Sant",
"redeemed": false
}
],
"warnings": [],
"errors": [],
"success": true
}
API specific error code
HTTP Status | Error Code (API-Specific) | Description |
---|---|---|
400 | INVALID_CUSTOMER_ID | Invalid or malformed customerId (e.g., non-numeric or negative value). |
401 | UNAUTHORIZED | Missing/invalid authentication token or insufficient permissions. |
403 | FORBIDDEN | Customer exists but requester lacks access to their coupons. |
404 | CUSTOMER_NOT_FOUND | No customer exists with the provided customerId . |
404 | NO_COUPONS_FOUND | Customer exists but has no coupons. |
500 | INTERNAL_SERVER_ERROR | Server-side failure (e.g., database timeout). |