Check if coupon is Redeemable

Lets you check whether a set of coupons can be redeemed or not.

📘

Any one customer identifier is mandatory.

Query parameter

ParameterDatatypeDescription
userobjPass the identifier of the customer to check if his/her coupon is redeemable.
mobile/email/externalId/idstringPass any of the identifiers of the customer.
codestringPass the coupon code that you want to check for redemption. You can also pass multiple coupon codes separating each with a comma ,
detailsbooleanPass true to retrieve the details of the coupon series.
details=extended-Retrieves the details of coupon configurations (set on campaign) of that specific coupon series.

Response parameter

ParameterDescription
accountIdAccount ID associated with the profile.
autoUpdateTimeDate and time of when the profile was last automatically updated.
commChannels[]List of communication channels associated with the profile.
fieldsAny additional fields associated with the profile.
firstNameFirst name of the customer in the profile.
typeType of the identifier (e.g., email, externalId, mobile).
valueValue of the identifier.
lastNameLast name of the customer in the profile.
userIdUser ID associated with the profile.
appendedErrorMessageError message appended during redemption.
codeCode of the redemption.
isAbsoluteWhether the redemption value is absolute.
isRedeemableWhether the coupon is currently redeemable.
numberOfRedemptionsByUserNumber of times the coupon has been redeemed by the user.
redemptionsLeftNumber of redemptions left for the coupon.
warnings[]List of warnings related to the redemption.
messageMessage related to the redemption status.
statusOverall status of the redemption.
discountTypeType of discount (e.g., percentage, flat). Displayed only when details=true or details=extended.
discountValueValue of the discount. Displayed only when details=true or details=extended.
discountUptoMaximum discount allowed. Displayed only when details=true or details=extended.
couponseriesCoupon series object and related metadata. Displayed only when details=true or details=extended.
descriptionDescription of the coupon. Displayed only when details=true.
discountCodeDiscount code used. Displayed only when details=true.
validTillDateExpiration date of the coupon. Displayed only when details=true.
validTilldateFormatFormat of the validTillDate. Displayed only when details=true.
isValidWithDiscountedItemWhether the coupon can be used with discounted items. Displayed only when details=true.
isUpdateProductDataWhether product data should be updated. Displayed only when details=true.
updateProductDataUpdate requirement for product data. Displayed only when details=true.
infoAdditional coupon information. Displayed only when details=true.
maxRedemptionsInSeriesPerUserMaximum redemptions allowed per user in the coupon series. Displayed only when details=true.
issueToLoyaltyWhether the coupon is issued to a loyalty program. Displayed only when details=true.
discountOnWhat the discount applies to (e.g., product, category). Displayed only when details=true.
brands[]Applicable brand-level data. Displayed only when details=extended.
products[]Applicable product-level data. Displayed only when details=extended.
categories[]Applicable category-level data. Displayed only when details=extended.
entityLevelRedemptionConfigsValues[]Entity-specific redemption configuration values. Displayed only when details=extended.
Language
URL
Click Try It! to start a request and see the response here!