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.

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

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Response

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

application/json

text/plain

200200

400400