Represents an offer from the business.
Properties
| id | The id of the offer. |
| partnerToken | An id assigned by the partner. |
| description |
The description for the offer.
This field may be null when there is no value or not applicable. |
| rewardType | The type of the reward value. |
| rewardValue | The reward that the user will earn when this offer is redeemed. |
| notActivatedRewardType | The type of the not-activated reward value. |
| notActivatedRewardValue | The not-activated reward value (if any). |
| rewardMax | The maximum possible reward value for any given redemption. |
| dateRewardChanged |
The date the that reward or fee last changed on. Only used on dynamic offers. The value will also be null if it is dynamic but the reward has never been changed since it was created.
This field may be null when there is no value or not applicable. |
| feeType | The type of the marketing fee. |
| feeValue | The marketing fee value. |
| feeMax | The marketing fee maximum. |
| notActivatedFeeType | The type of the not-activated reward value. |
| notActivatedFeeValue | The not-activated reward value (if any). |
| finePrint | The fine print represents a textual description of the offer requirements. |
| imageUrl |
If present, this image must be displayed next to the offer.
This field may be null when there is no value or not applicable. |
| requiresActivation | Whether or not the offer is a click-to-activate style offer which would require a button and a call to the /user/activate endpoint. |
| basic | Whether this offer is a basic offer. These offers are very simple and only have max reward and may have a variable reward calendar specified but no other limitations. |
| details | Has the more detailed offer criteria. This is useful for partners that apply the criteria themselves or want to build custom UIs to represent the offer criteria. See offerDetails details |
| excludedBySchedule |
Convenience field that determines if the schedule (if defined) would yield a reward if the customer transacted at this moment.
This field is optional and will not be returned when there is no value or not applicable. |
| link |
This will only be populated when: 1) There is a loggedInUser or userToken. 2) It is a search OR a direct business lookup.
This field is optional and will not be returned when there is no value or not applicable. See offerLink details |
| venue |
This will only be populated when returning offer links for a user.
This field is optional and will not be returned when there is no value or not applicable. See compactVenue details |