Skip to content

Get Offer By Id

This endpoint gets information on the Offer by an offerId and customerid.

1
GET /customers/<customerId>/offers/<offerId>

Input Parameters

Path Param Type Required Description
customerId int Required Unique identifier for customer
offerId int Required Unique identifier of the offer

Output

This endpoint returns OfferResponse object.

Example

Request

1
GET /v1/customers/2349/offers/1000024950

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
{
      "offerId": 1000024990,
      "offerStatus": {
      "id": 5,
      "name": "Expired"
      },
      "startDt": "2021-10-25T00:00:00",
      "endDt": "2021-11-08T00:00:00",
      "redemptionStartDt": "2021-10-25T00:00:00",
      "redemptionEndDt": "2021-11-09T00:00:00",
      "minSpend": 0.2,
      "minVisit": 1,
      "isCumulative": false,
      "isMultipleReward": false,
      "redeemedCount": 0,
      "preMessage": "Earn {Amount} on your {MerchantName} purchase!",
      "redemptionName": "Subway",
      "isParked": false,
      "customerId": 2349,
      "name": "SD_StoreLocations-SmokeTest_BJD_2021-10-25-09-01",
      "postMessage": "Earn 0.1 $ per $1 on your Subway purchase, with a 0.2 $ maximum.<br/><br/>SD_StoreLocations-SmokeTest_BJD_2021-10-25-09-01<br/><br/>Offer expires 11/8/2021. Offer valid one time only. <b>Payment must be made directly with the merchant.</b> Offer not valid on third-party delivery services. Payment must be made on or before offer expiration date.",
      "killedDt": "1753-01-01T00:00:00",
      "createDt": "0001-01-01T00:00:00",
      "rewardAmount": 0,
      "rewardPercent": 0.1,
      "rewardCap": 0.2,
      "activatedDt": null,
      "rewardType": 1,
      "currencyExchangeRate": 1,
      "currencyUnit": "$",
      "programName": "New Belgium Brewing",
      "description": "New Belgium Brewing",
      "isPercentage": true,
      "offerLinkURL1": "",
      "offerLinkText1": "",
      "offerLinkURL2": "",
      "offerLinkText2": "",
      "offerLinkURL3": "",
      "offerLinkText3": "",
      "offerLinkURL4": "",
      "offerLinkText4": "",
      "offerLinkURL5": "",
      "offerLinkText5": "",
      "offerLinkURL6": "",
      "offerLinkText6": "",
      "offerLinkURL7": "",
      "offerLinkText7": "",
      "offerLinkURL8": "",
      "offerLinkText8": ""
}