v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Create coupon series

Lets you create a new coupon series for the org.

post/coupon/series

Request body

storeIdsJsoninteger[]

Unique IDs of the stores where the series is applicable.

isDvsEnabledboolean

Whether DVS is enabled for the coupon series or not. Pass true for DVS coupons.

dvsExpiryDatestring date

Date and time of expiry of the DVS campaign associated with the coupon series in YYYY-MM-DDThh:mm:ssZ.

shortSMSTemplatestring

Short message to send to users. Pass voucher_code to insert coupon code in the message.

campaignIdinteger

Unique ID of the campaign associated with the series.

maxRedemptionsInSeriesPerUserinteger

Limit number of time same user can redeem the coupon

minDaysBetweenRedemptioninteger

Minimum number of days between any two redemption

Response

200

idinteger

orgIdinteger

descriptionstring

discountCodestring

validTillDatestring

validDaysFromCreationinteger

expiryStrategyValueinteger

maxCreateinteger

maxRedeeminteger

isTransferrableboolean

anyUserboolean

sameUserMultipleRedeemboolean

isReferralExistingUsersAllowedboolean

isMultipleUseAllowedboolean

isValidationRequiredboolean

isValidWithDiscountedItemboolean

createdByinteger

numIssuedinteger

numRedeemedinteger

createdOnstring

lastUsedstring

seriesCodestring

smsTemplatestring

isSMSDisabledboolean

infostring

isMultipleVouchersPerUserAllowedboolean

doNotResendExistingVoucherboolean

mutualExclusiveSeriesIdsstring

storeIdsJsonstring

isDvsEnabledboolean

dvsExpiryDatestring

priorityinteger

shortSMSTemplatestring

maxVouchersPerUserinteger

minDaysBetweenVouchersinteger

maxReferralsPerRefereeinteger

discountUptointeger

discountValueinteger

dvsItemsstring

redemptionRangestring

minBillAmountinteger

maxBillAmountinteger

redeemAtStorestring

campaignIdinteger

tagstring

maxRedemptionsInSeriesPerUserinteger

minDaysBetweenRedemptioninteger

redemptionValidFromstring

sourceOrgIdinteger

issueToLoyaltyboolean

redeemStoreTypestring

offlineRedeemTypeboolean

isOldFlowEnabledboolean

isPreRedeemEventRequiredboolean

termsAndConditionsstring

signalRedemptionEventboolean

syncToClientboolean

showPinCodeboolean

numUploadedNonIssuedinteger

numUploadedTotalinteger

redemptionValidAfterDaysinteger

ownedBystring

ownerIdinteger

ownerValidityinteger

alphaNumericboolean

shortCodeLengthinteger

randomCodeLengthinteger

fixedExpiryDateinteger

numTotalinteger

latestIssualTimeinteger

latestRedemptionTimeinteger

resendMessageEnabledboolean

seriesTypestring

clientHandlingTypestring

expiryStrategyTypestring

discountOnstring

discountTypestring

updateProductDataboolean

externalIssualboolean

Example response

{
  "id": 86066,
  "orgId": 100458,
  "description": "DIWALI 10% OFF",
  "discountCode": "XYZ123",
  "validTillDate": "2021-05-09T00:00:00Z",
  "validDaysFromCreation": 30,
  "expiryStrategyValue": 1,
  "maxCreate": -1,
  "maxRedeem": -1,
  "isValidWithDiscountedItem": true,
  "createdBy": 75040399,
  "createdOn": "2021-05-13T11:11:42Z",
  "lastUsed": "2021-05-13T11:11:41Z",
  "seriesCode": "453163F75E8C4A2EAA2E",
  "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": "[]",
  "storeIdsJson": "[-1]",
  "dvsExpiryDate": "2021-05-13T00: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": "DIWALI 10% OFF",
  "maxRedemptionsInSeriesPerUser": 122,
  "minDaysBetweenRedemption": 962,
  "redemptionValidFrom": "2020-11-17T00: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": 1620518400000,
  "resendMessageEnabled": true,
  "seriesType": "UNDEFINED",
  "clientHandlingType": "DISC_CODE",
  "expiryStrategyType": "SERIES_EXPIRY",
  "discountOn": "BILL",
  "discountType": "ABS"
}