Skip to content

Get Redemptions

This endpoint gets list of redemptions for a customer.

1
GET /customers/<customerId>/redemptions?startdate=<startDate>&enddate=<endDate>

Input Parameters

Path Param Type Required Description
customerId int Required Unique identifier for customer
Query Param Type Required Description
merchantName string Optional The name of the merchant this offer is for. If provided, then this should be exact match of Merchant name
startDate string Optional Date string representing the from which date it should search for redemption
endDate string Optional Date string representing the to which date it should search for redemption

Output

This endpoint returns an array of RedemptionResponse.

Example

Request

1
GET /v1/customers/2349/redemptions?startdate=2021-07-07&enddate=2021-10-03

Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
[
    {
        "offerRedemptionId": 23,
        "merchantName": "Ace Hardware",
        "offerId": 1000024990,
        "customerId": 2349,
        "generatedDt": "2021-10-25T00:00:00",
        "paidDt": "2021-11-08T00:00:00",
        "rewardAmount": 2
    }
]