v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get coupon series details

get/coupon/series

Query parameters

offsetinteger

Starting index for pagination. Default: 0. Must be greater than or equal to 0.

limitinteger

Maximum number of coupon series to return. Default: 1300. Must be at least 1. The maximum limit is configurable per environment (typically 1300).

status'ACTIVE' | 'INACTIVE' | 'BOTH'

Filter by coupon series status. Default: BOTH. Allowed values: ACTIVE, INACTIVE, BOTH.

Filter by owner type. Allowed values: NONE, LOYALTY, OUTBOUND, GOODWILL, DVS, TIMELINE, REFERRAL, JOURNEY.

Response

200

Example response

{
  "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,
      "anyUser": true,
      "isMultipleUseAllowed": true,
      "isValidWithDiscountedItem": true,
      "createdBy": 75121821,
      "numIssued": 3,
      "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}}",
      "info": "Evil coupon",
      "isMultipleVouchersPerUserAllowed": true,
      "doNotResendExistingVoucher": true,
      "mutualExclusiveSeriesIds": "[-1]",
      "storeIdsJson": "[-1]",
      "dvsExpiryDate": "2024-05-02T00:00:00Z",
      "shortSMSTemplate": "Hello {{cust_name}}, your voucher code is {{voucher_code}}",
      "maxVouchersPerUser": 11,
      "minDaysBetweenVouchers": 23,
      "maxReferralsPerReferee": -1,
      "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,
      "redeemStoreType": "redeemable_stores",
      "termsAndConditions": "T&C",
      "targetUserDetails": {
        "validMaxUserTransactionLimit": 1,
        "validUserRegistrationEndTime": 10000
      },
      "redemptionValidAfterDays": 22,
      "ownedBy": "NONE",
      "ownerId": -1,
      "alphaNumeric": true,
      "randomCodeLength": 10,
      "fixedExpiryDate": 1778284800000,
      "numTotal": -1,
      "latestIssualTime": 1717664404000,
      "resendMessageEnabled": true,
      "seriesType": "UNDEFINED",
      "clientHandlingType": "DISC_CODE",
      "expiryStrategyType": "SERIES_EXPIRY",
      "discountOn": "BILL",
      "discountType": "ABS"
    }
  ]
}