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

MethodPathDescription
GET/loyalty-rewardsList loyalty rewards
GET/loyalty-rewards/:idGet a loyalty reward
POST/loyalty-rewardsCreate a loyalty reward
PATCH/loyalty-rewards/:idUpdate a loyalty reward
DELETE/loyalty-rewards/:idDelete 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

FieldTypeDescription
idintegerRead-only. Unique ID.
organization_idintegerOrganization of the program. Required on create (must be the program's organization); cannot be changed.
program_idintegerLoyalty program of the reward. Required on create; cannot be changed.
namestringReward name (1 to 160 characters). Required on create.
descriptionstring | nullDescription (up to 2000 characters).
image_urlstring | nullImage URL (up to 2048 characters).
costnumberBalance needed (points or stamps), greater than 0. Required on create.
reward_typestringOne of free_item, discount_fixed, discount_percent, custom. Default custom.
discount_valuenumber | nullDiscount amount (discount_fixed) or percentage up to 100 (discount_percent). Required and greater than 0 for discount types.
product_idinteger | nullRelated product, if any.
min_tier_idinteger | nullMinimum tier required to redeem it. Must be a tier of the same program.
stockinteger | nullUnits available in total, 0 or more. null = unlimited.
code_validity_daysinteger | nullDays the reward code stays valid after redeeming (at least 1). null = no expiry.
statusstringOne of active, inactive. Default active. Only active rewards can be redeemed.
sort_orderintegerDisplay order. Default 0.
redeemed_countintegerRead-only. Units already redeemed (counted against stock).
created_atstring (date-time)Read-only. Creation time.
updated_atstring (date-time)Read-only. Last update time.
deleted_atstring (date-time) | nullRead-only. Set when the reward is deleted.

Related

Report an issue with this documentation

Please log in to report issues with our documentation.