curl --request POST \
--url "https://api.yukoapp.com/api/v1/public/customers/rewards/redeem" \
--header "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
--header "Content-Type: application/json" \
--data '{ "customer_id": "9049402769586", "reward_id": "90424fa7-e8a9-4ef4-b43a-72c9b2028db5" }'
const response = await fetch(
"https://api.yukoapp.com/api/v1/public/customers/rewards/redeem",
{
method: "POST",
headers: {
Authorization: "Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"Content-Type": "application/json",
},
body: JSON.stringify({
customer_id: "9049402769586",
reward_id: "90424fa7-e8a9-4ef4-b43a-72c9b2028db5",
}),
}
);
const data = await response.json();
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.yukoapp.com/api/v1/public/customers/rewards/redeem");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
"customer_id" => "9049402769586",
"reward_id" => "90424fa7-e8a9-4ef4-b43a-72c9b2028db5",
]));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"Content-Type: application/json",
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
{
"data": {
"coupon_code": "YUKO-TVJ-BL1",
"points_spent": 500,
"reward_type": "fixed",
"discount_value": 5,
"expires_at": "2026-06-01T00:00:00+00:00"
}
}
{
"error": {
"code": "redemption_failed",
"message": "Insufficient points balance"
}
}
{
"error": {
"code": "redemption_failed",
"message": "Reward not found or inactive"
}
}
{
"error": {
"code": "validation_error",
"message": "The reward id field is required.",
"details": {
"reward_id": ["The reward id field is required."]
}
}
}
{
"error": {
"code": "not_found",
"message": "Customer not found"
}
}
{
"error": {
"code": "invalid_token",
"message": "Invalid or revoked API token"
}
}
Customers
Redeem a reward
Exchanges a customer’s loyalty points for a reward and returns the generated discount code.
POST
/
public
/
customers
/
rewards
/
redeem
curl --request POST \
--url "https://api.yukoapp.com/api/v1/public/customers/rewards/redeem" \
--header "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
--header "Content-Type: application/json" \
--data '{ "customer_id": "9049402769586", "reward_id": "90424fa7-e8a9-4ef4-b43a-72c9b2028db5" }'
const response = await fetch(
"https://api.yukoapp.com/api/v1/public/customers/rewards/redeem",
{
method: "POST",
headers: {
Authorization: "Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"Content-Type": "application/json",
},
body: JSON.stringify({
customer_id: "9049402769586",
reward_id: "90424fa7-e8a9-4ef4-b43a-72c9b2028db5",
}),
}
);
const data = await response.json();
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.yukoapp.com/api/v1/public/customers/rewards/redeem");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
"customer_id" => "9049402769586",
"reward_id" => "90424fa7-e8a9-4ef4-b43a-72c9b2028db5",
]));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"Content-Type: application/json",
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
{
"data": {
"coupon_code": "YUKO-TVJ-BL1",
"points_spent": 500,
"reward_type": "fixed",
"discount_value": 5,
"expires_at": "2026-06-01T00:00:00+00:00"
}
}
{
"error": {
"code": "redemption_failed",
"message": "Insufficient points balance"
}
}
{
"error": {
"code": "redemption_failed",
"message": "Reward not found or inactive"
}
}
{
"error": {
"code": "validation_error",
"message": "The reward id field is required.",
"details": {
"reward_id": ["The reward id field is required."]
}
}
}
{
"error": {
"code": "not_found",
"message": "Customer not found"
}
}
{
"error": {
"code": "invalid_token",
"message": "Invalid or revoked API token"
}
}
Deducts the required points using FIFO logic, generates a coupon or discount code on the connected platform (for example Shopify), and returns the code to present to the customer. Store credit rewards are added to the customer’s Shopify store credit balance instead of returning a code.
Requires the
write:rewards scope. See Scopes.Body parameters
string
required
The platform customer ID, for example the Shopify customer ID.
string<uuid>
required
The UUID of the reward to redeem. Get it from the
rewards[].id field in the Get redeemable rewards response.Response
Returns201 Created.
object
Show data properties
Show data properties
string | null
The generated coupon or discount code to apply at checkout.
null for store credit rewards, which are added to the customer’s Shopify store credit balance instead.integer
The number of points deducted from the customer’s balance.
enum<string> | null
The type of reward that was redeemed. One of
fixed, percentage, free_shipping, free_product, store_credit, pos_fixed, pos_percentage.number
The discount amount or percentage associated with the coupon.
0 when the reward type has no discount value, including store credit rewards.string<date-time> | null
The expiry date of the generated coupon.
null if the reward has no expiry or is a store credit reward.Errors
| Status | Code | When |
|---|---|---|
401 | missing_token, invalid_token | The API key is missing, wrong or revoked. |
403 | insufficient_scope | The key doesn’t have write:rewards. |
404 | not_found | No customer matches customer_id (Customer not found). |
422 | validation_error | A body parameter is missing or invalid. |
422 | redemption_failed | Loyalty is turned off for the store (Loyalty not enabled). |
422 | redemption_failed | The customer is banned (Customer banned). |
422 | redemption_failed | The reward doesn’t exist or is inactive (Reward not found or inactive). |
422 | redemption_failed | The customer doesn’t have enough points (Insufficient points balance). |
422 | redemption_failed | The discount or store credit can’t be created on the platform, for example Failed to generate platform coupon. |
429 | The key exceeded the rate limit. |
curl --request POST \
--url "https://api.yukoapp.com/api/v1/public/customers/rewards/redeem" \
--header "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
--header "Content-Type: application/json" \
--data '{ "customer_id": "9049402769586", "reward_id": "90424fa7-e8a9-4ef4-b43a-72c9b2028db5" }'
const response = await fetch(
"https://api.yukoapp.com/api/v1/public/customers/rewards/redeem",
{
method: "POST",
headers: {
Authorization: "Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"Content-Type": "application/json",
},
body: JSON.stringify({
customer_id: "9049402769586",
reward_id: "90424fa7-e8a9-4ef4-b43a-72c9b2028db5",
}),
}
);
const data = await response.json();
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.yukoapp.com/api/v1/public/customers/rewards/redeem");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
"customer_id" => "9049402769586",
"reward_id" => "90424fa7-e8a9-4ef4-b43a-72c9b2028db5",
]));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"Content-Type: application/json",
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
{
"data": {
"coupon_code": "YUKO-TVJ-BL1",
"points_spent": 500,
"reward_type": "fixed",
"discount_value": 5,
"expires_at": "2026-06-01T00:00:00+00:00"
}
}
{
"error": {
"code": "redemption_failed",
"message": "Insufficient points balance"
}
}
{
"error": {
"code": "redemption_failed",
"message": "Reward not found or inactive"
}
}
{
"error": {
"code": "validation_error",
"message": "The reward id field is required.",
"details": {
"reward_id": ["The reward id field is required."]
}
}
}
{
"error": {
"code": "not_found",
"message": "Customer not found"
}
}
{
"error": {
"code": "invalid_token",
"message": "Invalid or revoked API token"
}
}