Coupon (V2 APIs)

Coupon represents store promotions or discounts created through Capillary Campaign Manager. A single campaign could contain one or more coupons or coupon series. Coupons are issued to loyalty or non-loyalty customers through SMS or email.

You cannot create new coupons using coupon APIs. You can just send or retrieve coupons that are already created in your campaigns. Hence, it is important to note the coupon code, coupon id or coupon series id for making API calls.

You cannot create new coupons using coupon APIs; instead, you can send or retrieve coupons that are already created in your campaigns. Hence, it is important to note the coupon code, coupon id or coupon series id to use coupon APIs.

The V2 coupon entity just allows you to -

  • Redeem coupons in batch
  • Check whether specific coupons can be redeemed or not

For any other coupon related APIs, please use v1.1 APIs.

Status Codes

Error Codes

CodeDescription
500All requests have failed due to errors
510Invalid Redemption ids present
629Invalid Input. This can also occuer if you try to redeem more than 100 coupons.
660Coupon code has been revoked
661No Redemption id passed
683Voucher Redemption event failed
687Points activities are queued and will be updated later
700Coupon series fetched successfully
Coupon processing successful.
Coupon resent successfully.
Coupon processing successful.
Coupon isRedeem successful
701The customer could not be found. Please check mobile, email, external id passed
702Coupon code is invalid
707Coupon Series ID is invalid
703Coupon not issued to this customer
704Error in sending coupon through SMS
705Both coupon code and the validation code are invalid
707Coupon Series ID = {x} is invalid
709Coupon processing failed
710Coupon is not meant for this customer
711Coupon is already used
712Coupon Series / Campaign has expired
713Coupon has expired
714Campaign over, it was first come first serve
715Invalid organization
716Cannot redeem same Coupon multiple times
718Transaction number needed for redemption
719Coupon code does not exist
720Coupon is a test Coupon. Cannot be redeemed
721Invalid customer
722Unable to create coupon
723Coupon not issued to this customer
724Unable to communicate information to customer
725Validation required
726Validation not required
728Maximum number of redemptions reached
729Invalid redemption range For coupon series
730Unknown error
731Coupon redemption successful
732No Missed call received from the customer
733Invalid transaction amount
735Invalid store
736Allowed redemption consumed
738Allowed redemption gap is invalid
739Allowed redemption date is invalid
740Fraud customer
742Coupon issue and redemption blocked for customer
744Couldn't save coupon series fields
745Saved coupon series fields successfully
746Please provide series id
747Multiple redemption not allowed
748Coupon service timed out
749Coupon Redeem/isRedeem failed because of failure on other coupons in the batch
750Operation not allowed. Not allowed - customer is marked as fraud.
751coupon series with same series code is already present
752coupon series with same series code is already present
753series code cannot be empty
754generic cannot be empty for series type GENERIC
755invalid coupon series id
756invalid value for mutually exclusive config series
759Coupon redemption failed
777coupon source not valid for issue coupon
780Coupon not found Identifier: {x}.
Coupon isRedeem failed
781Either coupon ID or coupon code is missing
786Coupon processing failed, Please try again later
787Coupon processing failed, Please try again later
788Invalid configuration. Please report to capillary support
789Coupon processing failed, Please try again later
790Coupon processing failed, Please try again later
791Coupon processing failed, Please try again later
792Coupon processing failed, Please try again later
793Coupon processing failed, Please try again later
794Coupon processing failed, Please try again later
795Invalid configuration. Please report to capillary support.
796Coupon processing failed, Please try again later
797Coupon processing failed, Please try again later
798Coupon processing failed, Please try again later
799Invalid configuration. Please report to capillary support
1000Filters not provided