get https://{host}/v2/coupon/series
Retrieves the details of one or more coupon series.
Query parameter
Parameter | Description |
---|---|
ids | Unique offer IDs that you want to fetch. |
Response parameter
Parameter | Description |
---|---|
id | Unique identifier for the offer. |
orgId | Organization ID associated with the offer. |
description | Description of the offer. |
discountCode | Discount code provided by the user. |
validTillDate | The date until which the offer is valid. |
validDaysFromCreation | Number of days from creation that the offer is valid. |
expiryStrategyValue | The value related to the expiry strategy. |
maxCreate | Maximum number of offers that can be created. |
maxRedeem | Maximum number of offers that can be redeemed. |
isTransferrable | Boolean indicating if the offer is transferrable. |
anyUser | Boolean indicating if any user can use the offer. |
sameUserMultipleRedeem | Boolean indicating if the same user can redeem multiple times. |
isReferralExistingUsersAllowed | Boolean indicating if referral is allowed for existing users. |
isMultipleUseAllowed | Boolean indicating if multiple uses of the offer are allowed. |
isValidationRequired | Boolean indicating if validation is required for the offer. |
isValidWithDiscountedItem | Boolean indicating if the offer is valid with discounted items. |
createdBy | ID of the user who created the offer. |
numIssued | Number of offers issued. |
numRedeemed | Number of offers redeemed. |
createdOn | Date and time when the offer was created. |
lastUsed | Date and time when the offer was last used. |
seriesCode | Code for the offer series. |
smsTemplate | Template for the SMS that is sent to users. |
isSMSDisabled | Boolean indicating if SMS is disabled. |
info | Information about the offer. |
isMultipleVouchersPerUserAllowed | Boolean indicating if multiple vouchers per user are allowed. |
doNotResendExistingVoucher | Boolean indicating not to resend existing vouchers. |
mutualExclusiveSeriesIds | IDs of mutually exclusive series. |
storeIdsJson | IDs of stores where the offer is valid. |
isDvsEnabled | Boolean indicating if DVS (Digital Voucher System) is enabled. |
dvsExpiryDate | Expiry date for DVS. |
priority | Priority level of the offer. |
shortSMSTemplate | Short SMS template for the offer. |
maxVouchersPerUser | Maximum number of vouchers allowed per user. |
minDaysBetweenVouchers | Minimum days between issuance of vouchers. |
maxReferralsPerReferee | Maximum referrals allowed per referee. |
discountUpto | Maximum discount value. |
discountValue | Discount value of the offer. |
dvsItems | Items for DVS. |
redemptionRange | Range in which redemption is allowed. |
minBillAmount | Minimum bill amount for offer redemption. |
maxBillAmount | Maximum bill amount for offer redemption. |
redeemAtStore | Stores where redemption is allowed. |
campaignId | ID of the associated campaign. |
tag | Tag for the offer series. |
maxRedemptionsInSeriesPerUser | Maximum redemptions in series per user. |
minDaysBetweenRedemption | Minimum days between redemptions. |
redemptionValidFrom | Date from which the redemption is valid. |
sourceOrgId | Source organization ID. |
issueToLoyalty | Boolean indicating if the offer should be issued to loyalty members. |
redeemStoreType | Type of store where redemption is valid. |
offlineRedeemType | Boolean indicating if offline redemption is allowed. |
isOldFlowEnabled | Boolean indicating if the old flow is enabled. |
isPreRedeemEventRequired | Boolean indicating if a pre-redemption event is required. |
termsAndConditions | Terms and conditions for the offer. |
signalRedemptionEvent | Boolean indicating if a redemption event should be signaled. |
syncToClient | Boolean indicating if the offer should be synced to the client. |
showPinCode | Boolean indicating if the pin code should be shown. |
numUploadedNonIssued | Number of uploaded offers not issued. |
numUploadedTotal | Total number of uploaded offers. |
redemptionValidAfterDays | Number of days after which the redemption becomes valid. |
ownedBy | Ownership details for the offer. |
ownerId | Owner ID for the offer. |
ownerValidity | Validity of the owner. |
alphaNumeric | Boolean indicating if the code is alphanumeric. |
shortCodeLength | Length of the short code for the offer. |
randomCodeLength | Length of the random code for the offer. |
fixedExpiryDate | Fixed expiry date for the offer. |
numTotal | Total number of offers. |
latestIssualTime | Latest time of offer issuance. |
latestRedemptionTime | Latest time of offer redemption. |
resendMessageEnabled | Boolean indicating if the resend message feature is enabled. |
seriesType | Type of offer series. |
clientHandlingType | The type of client handling for the offer. |
expiryStrategyType | The type of expiry strategy for the offer. |
discountOn | What the discount is applied on. |
discountType | The type of discount provided by the offer. |
externalIssual | Boolean indicating if external issuance is allowed. |
updateProductData | Boolean indicating if the product data should be updated. |