curl --request GET \
--url "https://api.yukoapp.com/api/v1/public/customers/rewards?customer_id=9049402769586&status=active&per_page=20" \
--header "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
const customerId = "9049402769586";
const params = new URLSearchParams({ status: "active", per_page: 20 });
const response = await fetch(
`https://api.yukoapp.com/api/v1/public/customers/rewards?customer_id=${customerId}&${params}`,
{
method: "GET",
headers: {
Authorization: "Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
},
}
);
const data = await response.json();
$customerId = "9049402769586";
$query = http_build_query(["status" => "active", "per_page" => 20]);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.yukoapp.com/api/v1/public/customers/rewards?customer_id={$customerId}&{$query}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
{
"data": [
{
"id": "1fd80ced-326f-4082-951b-21a38632a603",
"customer_id": "63a2c89a-9936-4bc0-9d5f-93db46110b76",
"reward_id": "90424fa7-e8a9-4ef4-b43a-72c9b2028db5",
"reward_type": "fixed",
"status": "active",
"discount_code": "YUKO-TVJ-BL1",
"points_used": 500,
"expires_at": "2026-06-01T00:00:00+00:00",
"used_at": null,
"created_at": "2026-02-15T08:30:00+00:00"
}
],
"meta": {
"pagination": {
"current_page": 1,
"per_page": 20,
"total": 1,
"last_page": 1,
"has_more": false
}
}
}
{
"error": {
"code": "not_found",
"message": "Customer not found"
}
}
{
"error": {
"code": "invalid_token",
"message": "Invalid or revoked API token"
}
}
Customers
List customer rewards
Retrieves a paginated list of discount codes issued to a customer, such as rewards redeemed with points.
GET
/
public
/
customers
/
rewards
curl --request GET \
--url "https://api.yukoapp.com/api/v1/public/customers/rewards?customer_id=9049402769586&status=active&per_page=20" \
--header "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
const customerId = "9049402769586";
const params = new URLSearchParams({ status: "active", per_page: 20 });
const response = await fetch(
`https://api.yukoapp.com/api/v1/public/customers/rewards?customer_id=${customerId}&${params}`,
{
method: "GET",
headers: {
Authorization: "Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
},
}
);
const data = await response.json();
$customerId = "9049402769586";
$query = http_build_query(["status" => "active", "per_page" => 20]);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.yukoapp.com/api/v1/public/customers/rewards?customer_id={$customerId}&{$query}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
{
"data": [
{
"id": "1fd80ced-326f-4082-951b-21a38632a603",
"customer_id": "63a2c89a-9936-4bc0-9d5f-93db46110b76",
"reward_id": "90424fa7-e8a9-4ef4-b43a-72c9b2028db5",
"reward_type": "fixed",
"status": "active",
"discount_code": "YUKO-TVJ-BL1",
"points_used": 500,
"expires_at": "2026-06-01T00:00:00+00:00",
"used_at": null,
"created_at": "2026-02-15T08:30:00+00:00"
}
],
"meta": {
"pagination": {
"current_page": 1,
"per_page": 20,
"total": 1,
"last_page": 1,
"has_more": false
}
}
}
{
"error": {
"code": "not_found",
"message": "Customer not found"
}
}
{
"error": {
"code": "invalid_token",
"message": "Invalid or revoked API token"
}
}
Store credit redemptions don’t create a customer reward; they appear as points transactions instead. Results are sorted by
created_at, newest first.
Requires the
read:rewards scope. See Scopes.Query parameters
string
required
The platform customer ID, for example the Shopify customer ID.
enum<string>
Return only rewards with this status. One of
active, used, inactive, expired, deleted, revert.integer
default:20
The number of results per page. Must be between
1 and 100.integer
default:1
The page number to retrieve. See Classic pagination.
Response
object[]
The customer rewards on this page.
Show customer reward properties
Show customer reward properties
string<uuid>
Unique identifier for the customer reward.
string<uuid>
Yuko’s internal UUID for the customer this reward was issued to. This is not the platform customer ID you pass as
customer_id.string<uuid> | null
The UUID of the record that issued this reward, such as the catalogue reward that was redeemed.
string | null
The type of discount issued. For rewards redeemed with points, this is the catalogue reward’s
reward_type. null when no type was recorded. One of fixed, percentage, free_shipping, free_product, pos_fixed, pos_percentage.enum<string>
The current status of this reward. One of
active, used, inactive, expired, deleted, revert.string | null
The discount or coupon code issued to the customer.
integer
The number of loyalty points spent to generate this reward.
string<date-time> | null
When this reward expires.
null if it doesn’t expire.string<date-time> | null
When the reward was used.
null if not yet used.string<date-time>
When the reward was issued.
object
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 read:rewards. |
404 | not_found | No customer matches customer_id (Customer not found). |
429 | The key exceeded the rate limit. |
curl --request GET \
--url "https://api.yukoapp.com/api/v1/public/customers/rewards?customer_id=9049402769586&status=active&per_page=20" \
--header "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
const customerId = "9049402769586";
const params = new URLSearchParams({ status: "active", per_page: 20 });
const response = await fetch(
`https://api.yukoapp.com/api/v1/public/customers/rewards?customer_id=${customerId}&${params}`,
{
method: "GET",
headers: {
Authorization: "Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
},
}
);
const data = await response.json();
$customerId = "9049402769586";
$query = http_build_query(["status" => "active", "per_page" => 20]);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.yukoapp.com/api/v1/public/customers/rewards?customer_id={$customerId}&{$query}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
{
"data": [
{
"id": "1fd80ced-326f-4082-951b-21a38632a603",
"customer_id": "63a2c89a-9936-4bc0-9d5f-93db46110b76",
"reward_id": "90424fa7-e8a9-4ef4-b43a-72c9b2028db5",
"reward_type": "fixed",
"status": "active",
"discount_code": "YUKO-TVJ-BL1",
"points_used": 500,
"expires_at": "2026-06-01T00:00:00+00:00",
"used_at": null,
"created_at": "2026-02-15T08:30:00+00:00"
}
],
"meta": {
"pagination": {
"current_page": 1,
"per_page": 20,
"total": 1,
"last_page": 1,
"has_more": false
}
}
}
{
"error": {
"code": "not_found",
"message": "Customer not found"
}
}
{
"error": {
"code": "invalid_token",
"message": "Invalid or revoked API token"
}
}