post
https://{host}/upload/redeemFile/
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.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Request Body Parameters
| Parameter | Datatype | Description |
|---|---|---|
| customerIdentifier* | enum | Unique identifier of the customer to update redeemed coupons. Values: MOBILE, EXTERNAL_ID, EMAIL, USER_ID. |
| couponIdentifier* | enum | Coupon identifier used. Value: COUPON_ID, COUPON_CODE. |
| file* | file | The CSV file that contains information of redeemed coupons. Each row in CSV file can contain following fields(columns marked with * are mandatory).
redeemed date in millis, redeemed at, mobile, coupon code ,bill id, bill number, details 1603128622000,50015497,9988776655,ABCDEF1,1603128596000 luci_auto_15039 |
| uploadHeaders* | int | The sequence (starts from 0) of the columns in the attached csv file. This field accepts stringified JSON. Key name for the columns are as follows: Customer identifier: Key name for this field varies according to the customerIdentifier param. MOBILE : mobile EXTERNAL_ID: externalId EMAIL: email USER_ID: userId Coupon identifier : Key name for this field varies according to the couponIdentifier param. COUPON_ID: couponId COUPON_CODE: couponCode Redeemed date in milliseconds* : redeemedDateInMillis Redeemed at* : redeemedAt Bill Id : billId Bill Number : billNumber Details : details For the above file samples, the uploadHeaders will be: Sample 1 - {"redeemedDateInMillis": 0, "redeemedAt": 1, "billNumber": 5, "couponId": 3, "userId": 2, "billId": 4, "details": 6}Sample 2 - {"redeemedDateInMillis": 0, "redeemedAt": 1, "billNumber": 5, "couponCode": 3, "mobile": 2, "billId": 4, "details": 6} |
| Details | string | Any additional details or notes to capture for redeemed coupon upload. |
All parameters marked with * are mandatory.