Loyalty rewards
The reward catalog of a loyalty program.
A reward is what members of a points or stamps program can get with their balance: a free item, a fixed or percentage discount, or a custom benefit. List rewards to show what a customer can redeem and to get the reward_id for a redemption. Rewards can be managed in the Loyalty app or through this API.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /loyalty-rewards | List loyalty rewards |
GET | /loyalty-rewards/:id | Get a loyalty reward |
POST | /loyalty-rewards | Create a loyalty reward |
PATCH | /loyalty-rewards/:id | Update a loyalty reward |
DELETE | /loyalty-rewards/:id | Delete a loyalty reward |
The API key is scoped to one organization: reads are filtered to it automatically, and organization_id is required in the body on create.
The loyalty reward object
json
Fields
| Field | Type | Description |
|---|---|---|
id | integer | Read-only. Unique ID. |
organization_id | integer | Organization of the program. Required on create (must be the program's organization); cannot be changed. |
program_id | integer | Loyalty program of the reward. Required on create; cannot be changed. |
name | string | Reward name (1 to 160 characters). Required on create. |
description | string | null | Description (up to 2000 characters). |
image_url | string | null | Image URL (up to 2048 characters). |
cost | number | Balance needed (points or stamps), greater than 0. Required on create. |
reward_type | string | One of free_item, discount_fixed, discount_percent, custom. Default custom. |
discount_value | number | null | Discount amount (discount_fixed) or percentage up to 100 (discount_percent). Required and greater than 0 for discount types. |
product_id | integer | null | Related product, if any. |
min_tier_id | integer | null | Minimum tier required to redeem it. Must be a tier of the same program. |
stock | integer | null | Units available in total, 0 or more. null = unlimited. |
code_validity_days | integer | null | Days the reward code stays valid after redeeming (at least 1). null = no expiry. |
status | string | One of active, inactive. Default active. Only active rewards can be redeemed. |
sort_order | integer | Display order. Default 0. |
redeemed_count | integer | Read-only. Units already redeemed (counted against stock). |
created_at | string (date-time) | Read-only. Creation time. |
updated_at | string (date-time) | Read-only. Last update time. |
deleted_at | string (date-time) | null | Read-only. Set when the reward is deleted. |
Related
Report an issue with this documentation
Please log in to report issues with our documentation.