Get coupon series details

This API helps to retrieve the details of one or more coupon series.

Prerequisites

  • Authentication: Basic or OAuth authentication
  • Access group resource: Read access to coupon group resource

Resource information

URI/v2/coupon/series
HTTP methodGET
PaginationNA
Rate limitNA
Batch supportYes

API endpoint example

https://eucrm.cc.capillarytech.com/v2/coupon/series?ids=520591

Query parameter

ParameterData typeDescription
idsIntegerUnique offer IDs that you want to fetch.

Response parameter

Parameter Description

entity

Object

The object containing the details of the entity

customPropertyMap

Object

The object containing a collection of keys that represent unique property names and each value represents the corresponding property's value.

standard_terms_and_conditions

String

Custom field in the coupon series that provides information about the terms and conditions.

id

Integer

Unique identifier of the coupon series.

orgId

Integer

Organization ID associated with the coupon series.

description

String

Description of the coupon series.

discountCode

String

Code indicating the discount provided by the coupon

validTillDate

String

Validity of the card series in UTC timestamp. Format: YYYY-MM-DDTHH:MM:SS+/-(time-zone).

validDaysFromCreation

Integer

Number of days the coupon is valid from creation

expiryStrategyValue

Integer

Specifies the duration a coupon remains valid based on the expiryStrategyType.

For expiryStrategyType: "SERIES_EXPIRY", expiryStrategyValue is always 1, which defines the coupon expires based on the rules defined for its series.

For expiryStrategyType: "DAYS", and expiryStrategyValue: "5", specifies that coupon will be valid till 5 days of issuance

For expiryStrategyType: "MONTHS_END", and expiryStrategyValue: "10" specifies that the coupon will be valid for 10 months of issuance.

maxCreate

Integer

Maximum number of coupons that can be created.

maxRedeem

Integer

Maximum number of offers that can be redeemed.

isTransferrable

Boolean

Indicates if the coupon is transferable

anyUser

Boolean

Indicates if any user can use the offer.

redemptionPerCouponMaxLimit

Integer

Specifies the maximum number of times a particular coupon code can be redeemed across all users.

sameUserMultipleRedeem

Boolean

Indicates if the same user can redeem multiple times.

isReferralExistingUsersAllowed

Boolean

Indicates if the referral is allowed for existing users..

isMultipleUseAllowed

Boolean

Indicates if multiple uses of the offer are allowed.

isValidationRequired

Boolean

Indicates if validation is required for the coupon

isValidWithDiscountedItem

Boolean

Indicates if the offer is valid with discounted items.

createdBy

Integer

ID of the user who created the coupon series

numIssued

Integer

Number of coupons issued from this series

numRedeemed

Integer

Number of coupons redeemed from this series

createdOn

String

Date and time when the offer was created.

lastUsed

String

Date and time when the offer was last used.

seriesCode

String

Code for the coupon series.

smsTemplate

String

Template for the SMS that is sent to users.

isSMSDisabled

Boolean

Indicates if SMS notifications are disabled

info

String

Additional information about the coupon

isMultipleVouchersPerUserAllowed

Boolean

Indicates if multiple vouchers per user are allowed

doNotResendExistingVoucher

Boolean

Indicates if existing vouchers should not be resent

mutualExclusiveSeriesIds

String

Allows you to specify a list of offer IDs that are mutually exclusive to the current offer. If a customer already has a coupon from any of the offer IDs in this list, they will not be eligible to receive a coupon from the current series

isDvsEnabled

Boolean

Indicates if DVS (Dynamic Voucher System) is enabled

dvsExpiryDate

String

Expiry date for DVS.

priority

Integer

Priority level of the offer.

shortSMSTemplate

String

Short template for the SMS to be sent to users

maxVouchersPerUser

Integer

Maximum number of vouchers allowed per user

minDaysBetweenVouchers

Integer

Minimum number of days required between issuing vouchers to the same user

maxReferralsPerReferee

Integer

Maximum number of referrals allowed per referee

discountUpto

Integer

Maximum discount value.

discountValue

Integer

Discount value of the coupon

dvsItems

String

Items for DVS(dynamic voucher system).

redemptionRange

String

Redemption range in JSON format specifying days of the month, days of the week, and hours on which the customer can redeem the coupon.

minBillAmount

Integer

Minimum bill amount for offer redemption.

maxBillAmount

Integer

Maximum bill amount for offer redemption.

redeemAtStore

String

Stores IDs where redemption is allowed.

campaignId

Integer

Identifier of the campaign associated with the coupon

tag

String

Tag or label for the coupon

maxRedemptionsInSeriesPerUser

Integer

Maximum number of redemptions allowed per user in the series

minDaysBetweenRedemption

Integer

Minimum number of days required between redemptions

redemptionValidFrom

String

Start date and time from which the coupon can be redeemed

sourceOrgId

Integer

Identifier of the source organization

issueToLoyalty

Boolean

Indicates if the coupon is issued to loyalty members

redeemStoreType

String

Type of store where the coupon can be redeemed

offlineRedeemType

Boolean

Indicates if offline redemption is enabled

isOldFlowEnabled

Boolean

Indicates if the old redemption flow is enabled

isPreRedeemEventRequired

Boolean

Indicates if a pre-redeem event is required

termsAndConditions

String

Terms and conditions for the offer.

signalRedemptionEvent

Boolean

Indicates if a redemption event signal is required

syncToClient

Boolean

Indicates if the coupon data should be synchronized to the client

showPinCode

Boolean

Indicates if a PIN code should be displayed

numUploadedNonIssued

Integer

Number of non-issued coupons uploaded

numUploadedTotal

Integer

Total number of coupons uploaded

redemptionValidAfterDays

Integer

Number of days after which the coupon becomes valid

ownedBy

String

Ownership details for the offer.

ownerId

Integer

Identifier of the owner of the coupon

ownerValidity

alphaNumeric

Boolean

Indicates if the coupon code is alphanumeric

shortCodeLength

Integer

Length of the short code generated for the coupon

randomCodeLength

Integer

Length of the random code generated for the coupon

fixedExpiryDate

Integer

Fixed expiry date of the coupon (in epoch milliseconds)

numTotal

Integer

Total number of coupons issued

latestIssualTime

Integer

Latest issuance time of the coupon (in epoch milliseconds)

latestRedemptionTime

Integer

Latest redemption time of the coupon (in epoch milliseconds)

resendMessageEnabled

Boolean

Indicates if resending messages is enabled

seriesType

String

Type of coupon series

clientHandlingType

String

Method using which the coupons should be generated.

expiryStrategyType

Enum

Defines the method for coupon expiry.

discountOn

String

Type of discount

discountType

Enum

Specifies the type of discount provided by the coupon

externalIssual

Boolean

Indicating if external issuance is allowed.

updateProductData

Boolean

Indicating if the product data can be updated.

Warninigs

Array

List of warnings related to the coupon

{
    "entity": [
        {
            "customPropertyMap": {
                "standard_terms_and_conditions": "terms and condtion"
            },
            "id": 520591,
            "orgId": 100458,
            "description": "Onam 10% OFF",
            "discountCode": "Xjj123",
            "validTillDate": "2026-05-09T00:00:00Z",
            "validDaysFromCreation": 30,
            "expiryStrategyValue": 1,
            "maxCreate": -1,
            "maxRedeem": -1,
            "isTransferrable": false,
            "anyUser": true,
            "sameUserMultipleRedeem": false,
            "isReferralExistingUsersAllowed": false,
            "isMultipleUseAllowed": true,
            "isValidationRequired": false,
            "isValidWithDiscountedItem": true,
            "createdBy": 75121821,
            "numIssued": 3,
            "numRedeemed": 0,
            "createdOn": "2024-05-02T06:02:28Z",
            "lastUsed": "2024-05-02T06:02:28Z",
            "seriesCode": "3A8078C2BAB94235A46D",
            "smsTemplate": "Hi  {{first_name}} {{last_name}} your voucher code {{voucher}}is valid {{valid_days_from_create}}. {{fullname}} {{offer_name}}",
            "isSMSDisabled": false,
            "info": "Evil coupon",
            "isMultipleVouchersPerUserAllowed": true,
            "doNotResendExistingVoucher": true,
            "mutualExclusiveSeriesIds": "[-1]",
            "storeIdsJson": "[-1]",
            "isDvsEnabled": false,
            "dvsExpiryDate": "2024-05-02T00:00:00Z",
            "priority": 0,
            "shortSMSTemplate": "Hello {{cust_name}}, your voucher code is {{voucher_code}}",
            "maxVouchersPerUser": 11,
            "minDaysBetweenVouchers": 23,
            "maxReferralsPerReferee": -1,
            "discountUpto": 0,
            "discountValue": 500,
            "dvsItems": "items",
            "redemptionRange": "{\"dom\" : [1], \"dow\": [1], \"hours\": [1]}",
            "minBillAmount": 100,
            "maxBillAmount": 20000,
            "redeemAtStore": "[-1]",
            "campaignId": -1,
            "tag": "Onam 10% OFF",
            "maxRedemptionsInSeriesPerUser": 122,
            "minDaysBetweenRedemption": 962,
            "redemptionValidFrom": "2024-05-01T00:00:00Z",
            "sourceOrgId": -1,
            "issueToLoyalty": false,
            "redeemStoreType": "redeemable_stores",
            "offlineRedeemType": false,
            "isOldFlowEnabled": false,
            "isPreRedeemEventRequired": false,
            "termsAndConditions": "T&C",
            "signalRedemptionEvent": false,
            "syncToClient": false,
            "showPinCode": false,
            "targetUserDetails": {
                "validMaxUserTransactionLimit": 1,
                "validUserRegistrationStartTime": 0,
                "validUserRegistrationEndTime": 10000
            },
            "numUploadedNonIssued": 0,
            "numUploadedTotal": 0,
            "redemptionValidAfterDays": 22,
            "ownedBy": "NONE",
            "ownerId": -1,
            "ownerValidity": 0,
            "alphaNumeric": true,
            "shortCodeLength": 0,
            "randomCodeLength": 10,
            "fixedExpiryDate": 1778284800000,
            "numTotal": -1,
            "latestIssualTime": 1717664404000,
            "latestRedemptionTime": 0,
            "resendMessageEnabled": true,
            "seriesType": "UNDEFINED",
            "clientHandlingType": "DISC_CODE",
            "expiryStrategyType": "SERIES_EXPIRY",
            "discountOn": "BILL",
            "discountType": "ABS",
            "externalIssual": false,
            "updateProductData": false
        }
    ],
    "warnings": []
}
{
    "entity": [
        {
            "id": 698948,
            "orgId": 100737,
            "description": "LIKE1w2w2345678910",
            "discountCode": "XYZ1w23",
            "validTillDate": "2030-09-29T00:00:00Z",
            "validDaysFromCreation": 30,
            "expiryStrategyValue": 30,
            "maxCreate": -1,
            "maxRedeem": -1,
            "isTransferrable": false,
            "anyUser": true,
            "sameUserMultipleRedeem": true,
            "isReferralExistingUsersAllowed": false,
            "isMultipleUseAllowed": true,
            "isValidationRequired": false,
            "isValidWithDiscountedItem": false,
            "createdBy": 75154383,
            "numIssued": 0,
            "numRedeemed": 0,
            "createdOn": "2025-02-04T08:52:56Z",
            "lastUsed": "2025-02-04T08:52:55Z",
            "seriesCode": "fEDH0qD8rr",
            "smsTemplate": "Hi  {{first_name}}",
            "isSMSDisabled": false,
            "info": "LIKE12345678910",
            "isMultipleVouchersPerUserAllowed": true,
            "doNotResendExistingVoucher": true,
            "mutualExclusiveSeriesIds": "[]",
            "storeIdsJson": "[-1]",
            "isDvsEnabled": false,
            "dvsExpiryDate": "2025-02-04T00:00:00Z",
            "priority": 0,
            "shortSMSTemplate": "Hello {{cust_name}}, your voucher code is {{voucher_code}}",
            "maxVouchersPerUser": -1,
            "minDaysBetweenVouchers": -1,
            "maxReferralsPerReferee": -1,
            "discountUpto": 0,
            "discountValue": 500,
            "dvsItems": "items",
            "redemptionRange": "{\"dom\":[\"-1\"],\"dow\":[\"-1\"],\"hours\":[\"-1\"]}",
            "minBillAmount": 0,
            "maxBillAmount": 9007199254740991,
            "redeemAtStore": "[-1]",
            "campaignId": -1,
            "tag": "LIKE12345678910",
            "maxRedemptionsInSeriesPerUser": -1,
            "minDaysBetweenRedemption": -1,
            "redemptionValidFrom": "1970-01-01T00:00:00Z",
            "sourceOrgId": -1,
            "issueToLoyalty": false,
            "redeemStoreType": "redeemable_stores",
            "offlineRedeemType": false,
            "isOldFlowEnabled": false,
            "isPreRedeemEventRequired": false,
            "termsAndConditions": "T&C apply",
            "signalRedemptionEvent": false,
            "syncToClient": false,
            "showPinCode": false,
            "numUploadedNonIssued": 0,
            "numUploadedTotal": 0,
            "redemptionValidAfterDays": 0,
            "ownedBy": "NONE",
            "ownerId": -1,
            "ownerValidity": 0,
            "alphaNumeric": true,
            "shortCodeLength": 0,
            "randomCodeLength": 8,
            "fixedExpiryDate": 1916870400000,
            "numTotal": -1,
            "latestIssualTime": 0,
            "latestRedemptionTime": 0,
            "resendMessageEnabled": true,
            "redemptionPerCouponMaxLimit": 3,
            "seriesType": "UNDEFINED",
            "clientHandlingType": "DISC_CODE",
            "expiryStrategyType": "DAYS",
            "discountOn": "BILL",
            "discountType": "ABS",
            "externalIssual": false,
            "updateProductData": false
        }
    ],
    "warnings": []
}
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!