---
title: "Get coupon series details"
method: GET
path: "/coupon/series"
---

# Get coupon series details

`GET /coupon/series`

## Query parameters

- `offset` integer
- `limit` integer
- `status` 'ACTIVE' | 'INACTIVE' | 'BOTH'
- `ownedBy` 'NONE' | 'LOYALTY' | 'OUTBOUND' | 'GOODWILL' | 'DVS' | 'TIMELINE' | 'REFERRAL' | 'JOURNEY'

## Response `200`

200

- union
  - object
    - `entity` object[]
      - `customPropertyMap` object
        - `standard_terms_and_conditions` string
      - `id` integer
      - `orgId` integer
      - `description` string
      - `discountCode` string
      - `validTillDate` string
      - `validDaysFromCreation` integer
      - `expiryStrategyValue` integer
      - `maxCreate` integer
      - `maxRedeem` integer
      - `isTransferrable` boolean
      - `anyUser` boolean
      - `sameUserMultipleRedeem` boolean
      - `isReferralExistingUsersAllowed` boolean
      - `isMultipleUseAllowed` boolean
      - `isValidationRequired` boolean
      - `isValidWithDiscountedItem` boolean
      - `createdBy` integer
      - `numIssued` integer
      - `numRedeemed` integer
      - `createdOn` string
      - `lastUsed` string
      - `seriesCode` string
      - `smsTemplate` string
      - `isSMSDisabled` boolean
      - `info` string
      - `isMultipleVouchersPerUserAllowed` boolean
      - `doNotResendExistingVoucher` boolean
      - `mutualExclusiveSeriesIds` string
      - `storeIdsJson` string
      - `isDvsEnabled` boolean
      - `dvsExpiryDate` string
      - `priority` integer
      - `shortSMSTemplate` string
      - `maxVouchersPerUser` integer
      - `minDaysBetweenVouchers` integer
      - `maxReferralsPerReferee` integer
      - `discountUpto` integer
      - `discountValue` integer
      - `dvsItems` string
      - `redemptionRange` string
      - `minBillAmount` integer
      - `maxBillAmount` integer
      - `redeemAtStore` string
      - `campaignId` integer
      - `tag` string
      - `maxRedemptionsInSeriesPerUser` integer
      - `minDaysBetweenRedemption` integer
      - `redemptionValidFrom` string
      - `sourceOrgId` integer
      - `issueToLoyalty` boolean
      - `redeemStoreType` string
      - `offlineRedeemType` boolean
      - `isOldFlowEnabled` boolean
      - `isPreRedeemEventRequired` boolean
      - `termsAndConditions` string
      - `signalRedemptionEvent` boolean
      - `syncToClient` boolean
      - `showPinCode` boolean
      - `targetUserDetails` object
        - `validMaxUserTransactionLimit` integer
        - `validUserRegistrationStartTime` integer
        - `validUserRegistrationEndTime` integer
      - `numUploadedNonIssued` integer
      - `numUploadedTotal` integer
      - `redemptionValidAfterDays` integer
      - `ownedBy` string
      - `ownerId` integer
      - `ownerValidity` integer
      - `alphaNumeric` boolean
      - `shortCodeLength` integer
      - `randomCodeLength` integer
      - `fixedExpiryDate` integer
      - `numTotal` integer
      - `latestIssualTime` integer
      - `latestRedemptionTime` integer
      - `resendMessageEnabled` boolean
      - `seriesType` string
      - `clientHandlingType` string
      - `expiryStrategyType` string
      - `discountOn` string
      - `discountType` string
      - `externalIssual` boolean
      - `updateProductData` boolean
    - `warnings` unknown[]
      - unknown
  - object
    - `entity` object[]
      - `id` integer
      - `orgId` integer
      - `description` string
      - `discountCode` string
      - `validTillDate` string
      - `validDaysFromCreation` integer
      - `expiryStrategyValue` integer
      - `maxCreate` integer
      - `maxRedeem` integer
      - `isTransferrable` boolean
      - `anyUser` boolean
      - `sameUserMultipleRedeem` boolean
      - `isReferralExistingUsersAllowed` boolean
      - `isMultipleUseAllowed` boolean
      - `isValidationRequired` boolean
      - `isValidWithDiscountedItem` boolean
      - `createdBy` integer
      - `numIssued` integer
      - `numRedeemed` integer
      - `createdOn` string
      - `lastUsed` string
      - `seriesCode` string
      - `smsTemplate` string
      - `isSMSDisabled` boolean
      - `info` string
      - `isMultipleVouchersPerUserAllowed` boolean
      - `doNotResendExistingVoucher` boolean
      - `mutualExclusiveSeriesIds` string
      - `storeIdsJson` string
      - `isDvsEnabled` boolean
      - `dvsExpiryDate` string
      - `priority` integer
      - `shortSMSTemplate` string
      - `maxVouchersPerUser` integer
      - `minDaysBetweenVouchers` integer
      - `maxReferralsPerReferee` integer
      - `discountUpto` integer
      - `discountValue` integer
      - `dvsItems` string
      - `redemptionRange` string
      - `minBillAmount` integer
      - `maxBillAmount` integer
      - `redeemAtStore` string
      - `campaignId` integer
      - `tag` string
      - `maxRedemptionsInSeriesPerUser` integer
      - `minDaysBetweenRedemption` integer
      - `redemptionValidFrom` string
      - `sourceOrgId` integer
      - `issueToLoyalty` boolean
      - `redeemStoreType` string
      - `offlineRedeemType` boolean
      - `isOldFlowEnabled` boolean
      - `isPreRedeemEventRequired` boolean
      - `termsAndConditions` string
      - `signalRedemptionEvent` boolean
      - `syncToClient` boolean
      - `showPinCode` boolean
      - `numUploadedNonIssued` integer
      - `numUploadedTotal` integer
      - `redemptionValidAfterDays` integer
      - `ownedBy` string
      - `ownerId` integer
      - `ownerValidity` integer
      - `alphaNumeric` boolean
      - `shortCodeLength` integer
      - `randomCodeLength` integer
      - `fixedExpiryDate` integer
      - `numTotal` integer
      - `latestIssualTime` integer
      - `latestRedemptionTime` integer
      - `resendMessageEnabled` boolean
      - `redemptionPerCouponMaxLimit` integer
      - `seriesType` string
      - `clientHandlingType` string
      - `expiryStrategyType` string
      - `discountOn` string
      - `discountType` string
      - `externalIssual` boolean
      - `updateProductData` boolean
    - `warnings` unknown[]
      - unknown

## Other responses

- `400` — 400

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/versions/de241f2ed9b3/schema)