put https://{host}/v2/coupon/series/
Lets you update existing coupon series details.
Body Parameters
| Parameter | Description |
|---|---|
| customPropertyMap | A map containing custom properties associated with the coupon series. |
| description | Description of the coupon series. |
| discountCode | Code indicating the discount provided by the coupon. |
| validTillDate | The date until which the coupon is valid. |
| expiryStrategyValue | The value related to the expiry strategy. |
| maxCreate | Maximum number of coupons that can be created. |
| maxRedeem | Maximum number of coupons that can be redeemed. |
| anyUser | Boolean indicating if any user can use the coupon. |
| 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 coupon are allowed. |
| isValidWithDiscountedItem | Boolean indicating if the coupon is valid with discounted items. |
| smsTemplate | Template for the SMS that is sent to users. |
| isSMSDisabled | Boolean indicating if SMS is disabled. |
| info | Information about the coupon. |
| isMultipleVouchersPerUserAllowed | Boolean indicating if multiple vouchers per user are allowed. |
| doNotResendExistingVoucher | Boolean indicating not to resend existing vouchers. |
| mutualExclusiveSeriesIds | IDs of mutually exclusive series. |
| maxVouchersPerUser | Maximum number of vouchers per user. |
| minDaysBetweenVouchers | Minimum days between vouchers. |
| discountValue | Discount value of the coupon. |
| redemptionRange | Range in which redemption is allowed. |
| minBillAmount | Minimum bill amount for coupon redemption. |
| maxBillAmount | Maximum bill amount for coupon redemption. |
| maxRedemptionsInSeriesPerUser | Maximum redemptions in series per user. |
| minDaysBetweenRedemption | Minimum days between redemptions. |
| redemptionValidFrom | Date from which the redemption is valid. |
| productInfo | Information about the products on which the coupon can be applied. |
| redemptionOrgEntityDetails | Details about the organization entities where the coupon can be redeemed. |
| targetUserDetails | Details about the target users for the coupon. |
| redemptionValidAfterDays | Number of days after which the redemption becomes valid. |
| alphaNumeric | Boolean indicating if the code is alphanumeric. |
| randomCodeLength | Length of the random code for the coupon. |
| resendMessageEnabled | Boolean indicating if the resend message feature is enabled. |
| clientHandlingType | The type of client handling for the coupon. |
| expiryStrategyType | The type of expiry strategy for the coupon. |
| discountType | The type of discount provided by the coupon. |
Response parameter
| Parameter | Description |
|---|---|
| id | Unique identifier for the coupon series. |
| orgId | Organization ID associated with the coupon series. |
| description | Description of the coupon series. |
| discountCode | Code indicating the discount provided by the coupon. |
| validTillDate | The date until which the coupon is valid. |
| validDaysFromCreation | Number of days from creation that the coupon is valid. |
| expiryStrategyValue | The value related to the expiry strategy. |
| maxCreate | Maximum number of coupons that can be created. |
| maxRedeem | Maximum number of coupons that can be redeemed. |
| isTransferrable | Boolean indicating if the coupon is transferrable. |
| anyUser | Boolean indicating if any user can use the coupon. |
| 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 coupon are allowed. |
| isValidationRequired | Boolean indicating if validation is required for the coupon. |
| isValidWithDiscountedItem | Boolean indicating if the coupon is valid with discounted items. |
| createdBy | ID of the user who created the coupon series. |
| numIssued | Number of coupons issued from this series. |
| numRedeemed | Number of coupons redeemed from this series. |
| createdOn | Date and time when the coupon series was created. |
| lastUsed | Date and time when the coupon was last used. |
| seriesCode | Code for the coupon series. |
| smsTemplate | Template for the SMS that is sent to users. |
| isSMSDisabled | Boolean indicating if SMS is disabled. |
| info | Information about the coupon. |
| 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 coupon is valid. |
| isDvsEnabled | Boolean indicating if DVS (Digital Voucher System) is enabled. |
| dvsExpiryDate | Expiry date for DVS. |
| priority | Priority level of the coupon. |
| shortSMSTemplate | Short SMS template for the coupon. |
| 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 coupon. |
| dvsItems | Items for DVS. |
| redemptionRange | Range in which redemption is allowed. |
| minBillAmount | Minimum bill amount for coupon redemption. |
| maxBillAmount | Maximum bill amount for coupon redemption. |
| redeemAtStore | Stores where redemption is allowed. |
| campaignId | ID of the associated campaign. |
| tag | Tag for the coupon 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 coupon 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 coupon. |
| signalRedemptionEvent | Boolean indicating if a redemption event should be signaled. |
| syncToClient | Boolean indicating if the coupon should be synced to the client. |
| showPinCode | Boolean indicating if the pin code should be shown. |
| targetUserDetails | Details about the target users for the coupon. |
| numUploadedNonIssued | Number of uploaded coupons not issued. |
| numUploadedTotal | Total number of uploaded coupons. |
| redemptionValidAfterDays | Number of days after which the redemption becomes valid. |
| ownedBy | Ownership details for the coupon. |
| ownerId | Owner ID for the coupon. |
| ownerValidity | Validity of the owner. |
| alphaNumeric | Boolean indicating if the code is alphanumeric. |
| shortCodeLength | Length of the short code for the coupon. |
| randomCodeLength | Length of the random code for the coupon. |
| fixedExpiryDate | Fixed expiry date for the coupon. |
| numTotal | Total number of coupons. |
| latestIssualTime | Latest time of coupon issuance. |
| latestRedemptionTime | Latest time of coupon redemption. |
| resendMessageEnabled | Boolean indicating if the resend message feature is enabled. |
| seriesType | Type of coupon series. |
| clientHandlingType | The type of client handling for the coupon. |
| expiryStrategyType | The type of expiry strategy for the coupon. |
| discountOn | What the discount is applied on. |
| discountType | The type of discount provided by the coupon. |
| updateProductData | Boolean indicating if the product data should be updated. |
| externalIssual | Boolean indicating if external issuance is allowed. |
| warnings | List of any warnings associated with the coupon series. |