Best Offer
GET/client/users/:correlation_id/offer
Returns the most relevant offer information for the current session.
Query Parameters
You can add optionally add query parameters to control the business unit or locale for the best offer returned.
| Key | Value | Default | Notes/Examples |
|---|---|---|---|
| locale | Specify the locale setting for the offer(s) returned. | String, values supported are: "en-CA", "en-US", and "fr-CA" as well as "EN" and "FR" | Optional. Priority order: (1) this query parameter; (2) locale set on the account; (3) environment locale. If locale is not provided or is not a valid value, the configured environment default is used. |
| businessUnit | Name of business unit(s) for which offers should be returned. | String | Can provide name of one businessUnit (only data for that BU is returned) or more than one by having a "businessUnit" name value for each. If this parameter is not used, then offers for all BUs are returned. |
Request
Body
This request has no body.
Response
| Attribute | Definition | Format | Notes |
|---|---|---|---|
| id | The offer ID | String | |
| type | The type of offer | Enum: "FLAT", "MULTIPLIER", or "PERCENTAGE" | FLAT = rewards exact number of points when reward fires; MULTIPLIER = reward a multiple of base points; PERCENTAGE = reward a number of points based on the eligible spend equivalent to the percentage spent |
| rank | Sets the ranking priority of the offer | Number: 0-9 | Smaller numbers are higher ranks |
| acceptanceState | Whether or not the offer has been accepted | Enum: "ACCEPTED", "NONE", or "COMPLETED" | |
| acceptanceMethod | The method by which the offer was accepted | String: "LTC" | With LTC (Load to Card), the offer must be accepted by targeted member before performing the requested behaviour. |
| shortDescription1 | Additional field for offer copy | String | Any string value that is valid per corresponding regex restriction |
| shortDescription2 | Additional field for offer copy | String | Any string value that is valid per corresponding regex restriction |
| longDescription | Offer description used for display | String | Any string value that is valid per corresponding regex restriction |
| promotionHeadline | Primary offer title copy used for display | String | Any string value that is valid per corresponding regex restriction |
| tcMessage | The Terms and Conditions message | String | |
| expirationDate | The date on which the offer expires | String | |
| effectiveDate | The date on which the offer becomes effective | String | |
| smallImageURI | URI of small image | String | Any string value that is valid per corresponding regex restriction |
| largeImageURI | URI of large image | String | Any string value that is valid per corresponding regex restriction |
| smallHDImageURI | URI of small high-definition image | String | Any string value that is valid per corresponding regex restriction |
| largeHDImageURI | URI of large high-definition image | String | Any string value that is valid per corresponding regex restriction |
| rewardAmount | The amount of the reward | Number | |
| rewardDescription | Description of the reward to be had | String | For instance: "Spend 20, get 500 points." |
| promptMessageID | Contains ID of messages for the POS operator or member associated with the offer displayed | Array |
Error Responses
| statusCode | errorMessage | errorCode | Definition |
|---|---|---|---|
| 400 Bad Request | Invalid business unit(s) provided. | INVALID_BUSINESS_UNIT |
Request
Responses
- 200
- 400
200 - Best Offer for Current Session
400 - Business Unit Not Valid