Mark a Redemption as Used

Marks a customer's coupon redemption as used, for a coupon the customer used outside the normal checkout flow (for example, honored in store). The customer's points are not refunded, and there's no endpoint to undo it.

Get id, code and customer_id from Retrieve Reward Instances: send its id, reward_text and customer_id.

By default the coupon stays active in your ecommerce platform and can still be used at checkout. Send delete_code: true to also delete it there. That deletion is best effort: if it fails, the redemption is still marked as used and the response is still 200.

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

Authenticate with your Yotpo access token in the X-Yotpo-Token header (how to generate one). The token must belong to the store in the path.

Path Params
string
required

Your Yotpo store ID (app key).

Body Params
integer
required

The redemption's ID: id from Retrieve Reward Instances.

string
required

The redemption's coupon code: reward_text from Retrieve Reward Instances. Must match the redemption.

integer
required

The customer's Yotpo Loyalty ID: customer_id from Retrieve Reward Instances. This is not the customer's ID in your ecommerce platform.

boolean
Defaults to false

true to also delete the coupon in your ecommerce platform, so it can't be used at checkout.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain