Grant Reward
This endpoint grants the user a reward associated with the campaign provided.
Parameters
The campaign id to grant the reward for
The user to grant the reward for
Response
Reward ID
Developers that do not communicate directly with the Olo APIs can ignore this field.
The field is only present for merchants that have integrated with Olo. This UID should be used instead of the Reward ID when attempting to apply a reward to the basket when communicating directly with the Olo API.
This UID can also be used to match records (via the externalreference Olo
rewards API attribute) being returned by the Olo API to relevant reward or
points product records in the Thanx API.
User ID
Merchant ID
Campaign ID
Reward State (available, active, used)
Fine print for the reward
Staff instructions for the reward
Time the reward was given to the user in ISO8601-format
Time the reward was activated in ISO8601-format
Time the reward was marked as used in ISO8601-format
Time the reward will be automatically retired in ISO8601-format
This hash will be populated if the reward is 'active' or 'used' and the merchant uses coupon codes.
Details of how the reward was earned
Details of how the reward can be redeemed
Each of these values is a URL of the reward image with the aspect ratio preserved. Each property (EG: index.small) has a set width for all rewards, and the height varies based on the aspect ratio.
For example, if you import an image with the dimensions 1000x1000 (aspect ratio of 1:1), then the image for index.small has the dimensions 563x563 because it matches the original aspect ratio.