Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Upload Redeemed Coupons

Lets you upload coupons that are redeemed for a coupon series in bulk.

You can also import coupons (Capillary CRM) that are redeemed externally using an endpoint.

post/upload/redeemFile/{couponSeriesId}

Path parameters

couponSeriesIdstring required

Headers

Content-Type'multipart/form-data' required

Request body

customerIdentifier'MOBILE' | 'EXTERNAL_ID' | 'EMAIL' | 'USER_ID' required

Unique identifier of the customer to update redeemed coupons.

couponIdentifier'COUPON_ID' | 'COUPON_CODE' required

Coupon identifier used.

filestring

The CSV file that contains information of redeemed coupons. Each row in CSV file can contain following fields(columns marked with * are mandatory).

Response

200

successboolean
statusinteger

Example response

{
  "success": true,
  "status": 200,
  "result": {
    "orgId": 9619,
    "couponSeriesId": 953234,
    "redeemUploadJobStatuses": [
      {
        "jobId": 9137,
        "uploadRedeemedCouponStatus": "QUEUED",
        "createdOn": "1603263535389",
        "updatedOn": "1603263535389",
        "uploadedFileUrl": "couponCode_9603263533789_253294.csv",
        "uploadedFileName": "couponCode_9603263533789_253294.csv"
      }
    ],
    "fileName": "couponCode_9603263533789_253294.csv"
  }
}