Skip to content

Get Redemptions

Gets the redemptions for the customer (v4+).

1
GET /customers/<token>/redemptions

Input Parameters

Path Param Type Required Description
token string Required The security token for the customer
Query Param Type Required Description
channelId int Required Value from Channel list
locationId int Required Value from Location list
startDate string Optional An optional ISO-8601 formatted start date string to filter based on redemption date
endDate string Optional An optional ISO-8601 formatted end date string to filter based on redemption date

Output

This endpoint returns a RedemptionList object.

Property Type Server Version
Description
redemptions Redemption[] An array of all redemptions.
ads Ad[] An array of all ads which can be used to reference the ad ids within each redemption. The redemption property of each ad will be null. )

Example

Request

1
GET /api/v1/customers/C1FA3C38-1B28-4B54-A2F8-E577FFEEF9F5/redemptions?channelId=5&locationId=2&startDate=2019-03-22T09:39:25&endDate=2022-03-22T09:39:25

Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
{
   "redemptions": [
    {
        "redemptionId": 992745,
        "accountId": 25895672459,
        "adId": 2784221,
        "amount": 34.12,
        "date": "2019-03-21T12:58:34",
        "isMyReward": false,
        "paidAccountId": 388836454,
        "redeemingTransactionAmount": 34.46,
        "transactionId": 929994552,
        "rewardSettlementRunDate": "2019-03-21T23:59:50"
    }
   ]
   "ads":[
    {
        "adId": "10132748",
        "status": 2,
        "creatives": [
            {
                "shortPreMessage": "Save 10% at Bob's",
                "preMessage": "Save 10% on any purchase of $5 or more at Bob's Warehouse.",
                "postMessage": "Time and inventory is limited. Maximum of $30 back. Minimum transaction of $5 required. Terms and conditions apply. <a class='cardlytics_anchor_styling cardlytics_anchor_target' target='_blank' href='http://example.com' aria-label='here'>Please click here </a> to find a location near you.",
                "thankYouMessage": "Thank you for shopping! You saved $24.46!",
                "images": {
                    "logo": {
                        "url": "https://images.cardlytics.com/ads/logo/10132748.png",
                        "text": "Bob's Logo"
                    },
                    "heroImage": {
                        "url": "https://images.cardlytics.com/ads/hero/warehouse.png",
                        "text": "Warehouse Storefront"
                    }
                },
                "links" : {
                    "callToActionLink": {
                        "url": "http://example.com/callToActionLink/WestRock%0D/?ot=testFI&xt=gF49Db7mM7CA%2BRSOOVBYwwYtmXqWcYpU9JSU%2BfgreARy1PeUKsES18FA8nrIplgPQqo01Z2%2BZ4PpzJLLNZkYBquYsvYVo%2FZYFfNftz8Q2u6VgCCBurtYJ%2BxUWS%2BV915aKb5sCf09xJ4n7YiykWyHViyWAxzko7qp9QWlsaFxRhQ%3D",
                        "text": "Shop Now"
                    }
                },
                "beacons": {
                    "preMessageImpression": "http://example.com/foo",
                    "postMessageImpression": "http://example.com/bar"
                },
                "impressionToken": "CIy66gQoATAB"
            }
        ],
        "isParked": true,
        "categoryId": 3,
        "daysRemaining": 28,
        "endDate": "2019-03-22T09:39:25",
        "isPercentageOffer": true,
        "merchantName": "Bob's Warehouse",
        "offerAmount": 10.0,
        "maxRewardAmount": 30.0,
        "minSpendAmount": 5.0,
        "adType": 101,
        "isMappable": true,
        "redemptions": null,
        "tags": [
            {
                "key": "purchase-channel",
                "value": "In-Store"
            }
        ],
        "position": 4,
        "activatedDate": "2021-10-26T19:11:27Z"
    }
   ]
}