Rivo Loyalty: Rewards
{
list: [
{
code: "ONE_TIME_SHOPIFY_DISCOUNT_CODE",
createdAt: "2023-04-25T16:54:36.293Z",
enabled: true,
expiryMonths: null,
id: 168906,
loading: false,
minOrderValueInCents: null,
name: "$10 reward",
pointsAmount: 1000,
pointsType: "fixed",
prettyDisplayRewards: "$10 reward (1000 points required)",
redeemedCount: 3,
rewardType: "fixed_amount",
rewardValue: 10,
source: "points",
termsOfService: {
appliesTo: "entire",
rewardType: "fixed_amount",
showTos: false,
},
updatedAt: "2023-06-13T22:43:11.235Z",
},
{
createdAt: "2023-04-25T16:54:36.356Z",
enabled: true,
error: "Error message",
expiryMonths: null,
id: 168907,
minOrderValueInCents: null,
name: "$25 reward",
pointsAmount: 2500,
pointsType: "fixed",
prettyDisplayRewards: "$25 reward (2500 points required)",
redeemedCount: 4,
rewardType: "fixed_amount",
rewardValue: 25,
source: "points",
termsOfService: {
appliesTo: "entire",
rewardType: "fixed_amount",
showTos: false,
},
updatedAt: "2023-06-13T22:42:26.953Z",
},
{
createdAt: "2023-04-25T16:54:36.482Z",
enabled: true,
expiryMonths: null,
id: 168908,
minOrderValueInCents: null,
name: "$5 off coupon",
pointsAmount: 0,
pointsType: "fixed",
prettyDisplayRewards: "$5 off coupon (0 points required)",
redeemedCount: 1,
rewardType: "fixed_amount",
rewardValue: 5,
source: "referrer",
termsOfService: {
appliesTo: "entire",
rewardType: "fixed_amount",
showTos: false,
},
updatedAt: "2023-04-25T16:54:36.482Z",
},
],
pagination: {
amountOfPages: 3,
hasNextPage: false,
hasPreviousPage: false,
page: 1,
pageSize: 3,
totalElements: 9,
},
}
Properties
List of rewards
The code for the reward.
The date and time when the reward was created.
Whether the reward is enabled.
Error message if redeeming the reward failed.
The number of months the reward is valid for.
The ID of the reward.
Whether the reward is preparing the code.
The minimum order value required to redeem the reward, in cents.
The name of the reward.
The number of points required to redeem the reward.
The type of points required to redeem the reward.
A string representation of the reward.
The number of times the reward has been redeemed.
The type of reward.
The value of the reward.
The source of the reward.
The terms of service for the reward.
The products the reward applies to.
The type of reward.
Whether to show the terms of service for the reward.
The date and time when the reward was last updated.
Returns a pagination object.
Returns the total number of pages.
Returns true if there is a next page.
Returns true if there is a previous page.
Returns the current page number.
Returns the number of items per page.
Returns the total number of items.