Rewards
Create, retrieve, and list rewards that customers can redeem with their loyalty points.
A reward is a redemption option within the loyalty programme. Rewards have a points cost and can represent a discount percentage, a free item, or any other benefit you define.
Illustrative content. Hand-authored to demonstrate the Standard/Advanced pattern; the production page will be generated from the VINR OpenAPI spec (roadmap item #1). Field names are representative.
The reward objectAsk
idstringUnique identifier for the reward, e.g. rwd_5Hx2nP.
namestringHuman-readable name shown to customers, e.g. 10% Off Next Order.
points_costintegerNumber of points a customer must spend to redeem this reward.
typeenumEither discount (a percentage off) or item (a free product or service).
valuestringFor discount rewards: the percentage as a string, e.g. "10". For item rewards: a
description of what is granted, e.g. "Free coffee".
activebooleanWhether the reward is currently available for redemption. Inactive rewards are hidden from customers but their historical redemptions are preserved.
createdintegerUnix timestamp of when the reward was created.
Create a rewardAsk
Define a new redemption option. Set active: true (the default) to make it immediately available
to customers with sufficient points.
Retrieve a rewardAsk
Fetch a reward by its ID.
List rewardsAsk
Returns a paginated list of rewards. Pass active=true to show only currently redeemable rewards.
| Parameter | Type | Description |
|---|---|---|
active | boolean | Filter by active status. Omit to return all rewards. |
limit | integer | Number of results to return. Default 10, max 100. |
Related eventsAsk
reward.created. See Events.
