API Reference
ReviewsLoyaltyApp partnersHelp CenterAPI keys
  1. V3 · Loyalty

List rewards (storefront)

get
https://loyalty.yotpo.com/api/public/v1/redemption_options

Returns the rewards shoppers can redeem points for, for a rewards page or a redemption widget. It needs only your public Loyalty GUID, so you can call it from the browser. The server-side equivalent is Get Active Redemption Options, which needs your API key.

By default it returns the rewards shown online. Rewards limited to VIP tiers include vip_tiers and vip_tier_label.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Your Loyalty GUID. Find it in the Loyalty admin under Settings > General. It is public and safe to use in the browser.

string

Return only rewards of these discount types, as a comma-separated list, for example fixed_amount,percentage.

boolean

true returns only in-store (point of sale) rewards. Omit it for the rewards shown online.

boolean

false returns only coupons. true returns coupons and gift cards. Omit it to return every reward type.

boolean

Return only rewards that are (true) or aren't (false) set to show in the rewards widget.

Responses

Updated about 1 hour ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 hour ago

Did this page help you?