Get Detailed Customer Coupon Data

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 MethodGET
PaginationNo
Batch supportNo
Rate limit informationNone

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

ParametersData TypeDescription
customerIdIntegerUnique ID of the customer to fetch coupon details.

Request query parameters

ParametersData TypeDescription
coupon_code_caseEnumThis 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

ParameterTypeDescription
idIntegerUnique coupon ID.
seriesIdIntegerID of the associated coupon series.
seriesObjectSeries details
codeStringUnique coupon code (e.g., "QZX30JQLIC").
descriptionStringCoupon description.
createdDateString (ISO)Creation timestamp.
validTillString (ISO)Expiry timestamp. YYYY-MM-DDTHH:MM:SSZ
issuedToIntegerRecipient user ID.
issuedByIntegerIssuer user ID.
orgIdIntegerOrganization ID.
refIdIntegerReference ID (0 if none).
issuedAtObjectIssuing location
statusObjectOperation status
couponDiscountTypeStringDiscount type (e.g., "ABS").
issuedOnString (ISO)Issuance timestamp. YYYY-MM-DDTHH:MM:SSZ
activeFromString (ISO)Activation timestamp. YYYY-MM-DDTHH:MM:SSZ
redemptionsLeftIntegerRemaining redemptions (e.g., 4).
couponStatusObjectCoupon status (mirrors status).
redemptionInfoArrayRedemption history
reversedRedemptionInfoArrayReversed redemptions
discountTypeBooleanDeprecated: Use couponDiscountType.
discountValueIntegerDiscount amount (e.g., 1000).
discountValueAsDoubleDoubleDiscount value in double format.
discountUptoIntegerMaximum discount cap (0 for no cap).
trimmedCodeStringShortened coupon code.
seriesNameStringName of the coupon series.
redeemedBooleanIndicates redemption status: true = coupon has been redeemed, false = coupon is not redeemed

Series Object (entity[].series)

ParameterTypeDescription
idIntegerSeries ID.
orgIdIntegerOrganization ID.
descriptionStringSeries description.
discountCodeStringDiscount code (e.g., "uatMaySant").
validTillDateString (ISO)Series expiry timestamp. YYYY-MM-DDTHH:MM:SSZ
validDaysFromCreationIntegerValidity duration in days.
expiryStrategyValueIntegerExpiry strategy code.
maxCreateIntegerMaximum issuable coupons (e.g., 20).
maxRedeemIntegerMaximum redemptions (e.g., 20).
isTransferrableBooleanfalse if non-transferable.
anyUserBooleantrue if redeemable by any user.
sameUserMultipleRedeemBooleantrue if user can redeem multiple times.
isReferralExistingUsersAllowedBooleanfalse to block referrals for existing users.
isMultipleUseAllowedBooleantrue if multi-use allowed.
isValidationRequiredBooleanfalse if no validation needed.
isValidWithDiscountedItemBooleantrue if valid on discounted items.
createdByIntegerCreator user ID.
numIssuedIntegerNumber of coupons issued.
numRedeemedIntegerNumber of coupons redeemed.
createdOnString (ISO)Series creation timestamp. YYYY-MM-DDTHH:MM:SSZ
lastUsedString (ISO)Last redemption timestamp. YYYY-MM-DDTHH:MM:SSZ
seriesCodeStringInternal series code.
smsTemplateStringSMS notification template.
isSMSDisabledBooleanfalse if SMS enabled.
isUpdateProductDataBooleanfalse if product updates disabled.
infoStringAdditional series info.
isMultipleVouchersPerUserAllowedBooleantrue if users can hold multiple vouchers.
doNotResendExistingVoucherBooleantrue to avoid resending existing vouchers.
mutualExclusiveSeriesIdsStringJSON array of exclusive series IDs.
storeIdsJsonStringJSON array of valid store IDs.
isDvsEnabledBooleanfalse if Dynamic Voucher System (DVS) is disabled.
dvsExpiryDateString (ISO)DVS expiry timestamp.
priorityIntegerPriority level (e.g., 0).
shortSMSTemplateStringConcise SMS template.
maxVouchersPerUserIntegerMax vouchers per user (e.g., 5).
minDaysBetweenVouchersIntegerMinimum days between issuing vouchers.
maxReferralsPerRefereeIntegerMax referrals per user (-1 for unlimited).
discountUptoIntegerDiscount cap (0 for no cap).
discountValueIntegerDiscount amount (e.g., 1000).
dvsItemsStringDVS-specific items.
redemptionRangeStringJSON for redemption constraints.
minBillAmountIntegerMinimum bill amount to redeem (e.g., 100).
maxBillAmountIntegerMaximum bill amount to redeem (e.g., 20000).
redeemAtStoreStringJSON array of redemption store IDs.
campaignIdIntegerAssociated campaign ID (-1 if none).
tagStringSeries tag.
maxRedemptionsInSeriesPerUserIntegerMax redemptions per user (e.g., 4).
minDaysBetweenRedemptionIntegerMinimum days between redemptions.
redemptionValidFromString (ISO)Earliest redemption timestamp. YYYY-MM-DDTHH:MM:SSZ
sourceOrgIdIntegerSource organization ID (-1 if none).
issueToLoyaltyBooleanfalse if not issued via loyalty program.
redeemStoreTypeStringRedemption store type.
offlineRedeemTypeBooleanfalse if online-only redemption.
isOldFlowEnabledBooleanfalse if legacy flow disabled.
isPreRedeemEventRequiredBooleanfalse if no pre-redemption event needed.
brandsArrayAllowed brands (empty for all).
productsArrayAllowed products (empty for all).
categoriesArrayAllowed categories (empty for all).
termsAndConditionsStringTerms and conditions text.
signalRedemptionEventBooleanfalse if no event signaling needed.
syncToClientBooleanfalse if no client sync required.
showPinCodeBooleanfalse if PIN not required.
redemptionPerCouponMaxLimitIntegerMax redemptions per coupon (-1 for unlimited).
validRedemptionOrgEntityDetailsObjectValid redemption entities (see below).
seriesTypeStringSeries type (e.g., "UNDEFINED").
clientHandlingTypeStringClient handling type (e.g., "DISC_CODE").
expiryStrategyTypeStringExpiry strategy (e.g., "SERIES_EXPIRY").
discountOnStringDiscount applicability (e.g., "BILL").
discountTypeStringDiscount type (e.g., "ABS").
dvsExpiryDateFormatStringDVS expiry date in YYYY-MM-DD.
updateProductDataBooleanfalse if product updates disabled.
entityLevelRedemptionConfigsValuesArrayAdditional redemption configs (empty).
redemptionValidFromFormatStringRedemption start date in YYYY-MM-DD.
validTilldateFormatStringSeries expiry date in YYYY-MM-DD.

IssuedAt Object

ParameterTypeDescription
idIntegerLocation ID (e.g., 75152715).
codeStringLocation code (e.g., "doc123").
descriptionStringLocation description (empty).
nameStringLocation name (e.g., "DocStore").
typeStringLocation type (e.g., "STORE").
adminTypeStringAdmin type (e.g., "GENERAL").
isOrgUnitBooleanfalse if not an org unit.

Status Object

ParameterTypeDescription
statusCodeObjectStatus details (see below).
statusCode.statusBooleantrue if successful.
statusCode.codeIntegerStatus code
statusCode.messageStringStatus message (e.g., "Coupon Resent").
warningsArrayWarnings (empty).
warningsAsStatusCodeArrayWarnings in status format (empty).
codeIntegerDuplicate of statusCode.code.
successBooleanDuplicate of statusCode.status.
messageStringDuplicate 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 StatusError Code (API-Specific)Description
400INVALID_CUSTOMER_IDInvalid or malformed customerId (e.g., non-numeric or negative value).
401UNAUTHORIZEDMissing/invalid authentication token or insufficient permissions.
403FORBIDDENCustomer exists but requester lacks access to their coupons.
404CUSTOMER_NOT_FOUNDNo customer exists with the provided customerId.
404NO_COUPONS_FOUNDCustomer exists but has no coupons.
500INTERNAL_SERVER_ERRORServer-side failure (e.g., database timeout).
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!