Create Redemption

post

https://loyalty.yotpo.com/api/v2/redemptions

This endpoint will redeem a customer’s points for a particular redemption option. It will check to ensure the customer is eligible and has enough points for the selected redemption option and then it will deduct the points from their balance, generate the coupon code, and return it in the response.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Delayed Points Deduction

When passing the delay_points_deduction param as true, take the coupon code returned in the reward_text param and pass it via the coupon_code param of the\ Create Orderendpoint.

This will deduct the points associated with that point redemption from the customer upon order creation.

For example, if delay_points_dedcution is passed as true and a customer redeems 10 loyalty points for a coupon/discount, those points would only be deducted from the customer's point balance upon creation and processing of the order containing the coupon_code.

Body Params

customer_email

string

required

The email address of the customer redeeming points. Only required if no phone_number or pos_account_id is passed.

pos_account_id

string

required

The identifier used to uniquely identify the customer in your POS system. This is only required if no customer_email attribute or phone_number attribute is passed.

phone_number

string

required

The customer's phone number in E.164 format. e.g +14155552671. Must be an exact match. Only required if no customer_email or pos_account_id is passed.

customer_id

string

required

The identifier used to uniquely identify the customer in your system. Required if no customer_email, pos_account_id or phone_number is passed.

redemption_option_id

int32

required

The unique identifier of the redemption option being redeemed.

delay_points_deduction

boolean

Passing a value of true indicates that points will only be deducted when the order containing the redemption is received. See the section below to learn more.

currency

string

The currency used (e.g. 'USD.') This is required if you're using multi currency. If nothing is passed, it will default to your base currency.

points_to_redeem

int32

Number of points to be redeemed in this transaction. This is required for generic variable redemption. If nothing is passed, error message will be returned.

Responses

Delayed Points Deduction

200200

400400

404404

423423