OfferResponse

"OfferResponse" refers to a Customer's offer.

Property Type Description
offerId int Unique identifier of the offer
offerStatus OfferStatus The status of the offer for the customer. See the OfferStatus section for details
startDt string Date string representing the date the offer starts
endDt string Date string representing the date the offer expires
redemptionStartDt string Date string representing the start date of redemption
redemptionEndDt string Date string representing the end date of redemption
minSpend decimal The minimum transaction amount required to qualify for a reward, specified in monetary amount. Can be null, defined, or 0 if there is no minimum spend amount
minVisit int The minimum visits for the offer
isCumulative bool Whether or not the offer is cumulative
isMultipleReward bool Whether or not the offer is multi reward
redeemedCount int The number of redemptions for this offer
preMessage string The pre-expansion message to be displayed to the customer when the offer is closed or minimized
redemptionName string Name of the redemption
isParked bool Displays if an offer is parked or unparked
customerId int Customer ID to which offer is mapped
name string Name of the offer
postMessage string The post-expansion message of an offer to be displayed after an offer is expanded
killedDt string Date string representing the date the offer is killed
createDt string Date string representing the date the offer gets created
rewardAmount decimal The reward amount of an offer
rewardPercent decimal The reward percentage of an offer
rewardCap decimal The reward cap of an offer
activatedDt string Date string representing the date the offer get activated
rewardType RewardType The reward type for this offer. See the RewardType section for details
currencyExchangeRate decimal The currency exchange rate for the points or currency portfolio based on GBP. This is a multiplier, so 1.0 = 100%
currencyUnit string The currency of the rewards program. Ex: Cashback or points
programName string Name of rewards program
description string Description of the program
isPercentage bool Whether or not the offer for this offer is percentage-based instead of dollar-amount based
offerLinkURL1 string
offerLinkText1 string
offerLinkURL2 string
offerLinkText2 string
offerLinkURL3 string
offerLinkText3 string
offerLinkURL4 string
offerLinkText4 string
offerLinkURL5 string
offerLinkText5 string
offerLinkURL6 string
offerLinkText6 string
offerLinkURL7 string
offerLinkText7 string
offerLinkURL8 string
offerLinkText8 string

Example

 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": ""
}