Get Active Redemption Options

get https://loyalty.yotpo.com/api/v2/redemption_options

This endpoint returns a list of redemption options available for customers to redeem.

Response Parameters

Response Parameters	Type	Description
`id`	int	The redemption option unique id (`redemption_option_id`).
`name`	string	Option Title e.g. $5.00 off
`description`	string	Short Description. e.g. Get $5.00 off every item in our store for 500 points
`icon`	string	Image if URL. Otherwise, font awesome class name.
`cost_text`	string	How many points this option costs. e.g. 500 points
`amount`	string
`applies_to_product_type`	string
`duration`	string

Query Params

is_offline

string

By default, all redemption options will be returned. If set to true, only offline redemption options will be returned.

customer_email

string

The customer’s email address. Use this param to fetch only the redemptions a specific customer is qualified for.

customer_id

string

The identifier used to uniquely identify the customer in your system.

phone_number

string

The customer's phone number in E.164 format. e.g +14155552671. Must be an exact match. Use this param to fetch only the redemptions a specific customer is qualified for.

discount_type

string

By default, all redemption options will be returned. If a value is passed, only redemption options of that discount type will be returned.

Headers

x-guid

string

required

The Globally Unique Identifier found in the "Settings" section of your Yotpo loyalty admin.

x-api-key

string

required

Your account API key can be found in the "Settings" section of your Yotpo loyalty admin.

Responses

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://loyalty.yotpo.com/api/v2/redemption_options \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

Response Parameters

200200

400400