List redemptions to fulfil
curl --request GET \
--url https://api.rigaly.com/api/v1/redemptions \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.rigaly.com/api/v1/redemptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.rigaly.com/api/v1/redemptions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.rigaly.com/api/v1/redemptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"success": true,
"message": "<string>",
"data": {
"redemptions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "AB12CD34",
"status": "completed",
"fulfillment_status": "pending",
"created_at": "2023-11-07T05:31:56Z",
"shipped_at": "2023-11-07T05:31:56Z",
"delivered_at": "2023-11-07T05:31:56Z",
"tracking_reference": "1Z999AA10123456784",
"ship_to_name": "Jane Doe",
"ship_to_phone": "+15551234567",
"ship_to_email": "jane@example.com",
"ship_to_address": "123 Main St, Springfield, IL 62704",
"reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reward_name": "Limited edition shirt",
"reward_image_url": "<string>",
"points_cost": 5000,
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_name": "Jane Doe"
}
],
"pagination": {
"page": 1,
"limit": 25,
"total": 37,
"total_pages": 2
}
}
}{
"success": false,
"error": {
"message": "Invalid API key"
}
}Redemptions
List redemptions to fulfil
Lists shipping redemptions for your business, newest first — the
work queue for rewards whose delivery_mode is shipping. The
customer already paid the points and submitted an address; you post the
parcel and advance the status.
Only redemptions with a fulfillment_status appear here: in-store
redemptions (validated at your counter) and digital ones (delivered
instantly in the app) are not fulfilment work and are excluded. See the
delivery modes guide.
GET
/
api
/
v1
/
redemptions
List redemptions to fulfil
curl --request GET \
--url https://api.rigaly.com/api/v1/redemptions \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.rigaly.com/api/v1/redemptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.rigaly.com/api/v1/redemptions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.rigaly.com/api/v1/redemptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"success": true,
"message": "<string>",
"data": {
"redemptions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "AB12CD34",
"status": "completed",
"fulfillment_status": "pending",
"created_at": "2023-11-07T05:31:56Z",
"shipped_at": "2023-11-07T05:31:56Z",
"delivered_at": "2023-11-07T05:31:56Z",
"tracking_reference": "1Z999AA10123456784",
"ship_to_name": "Jane Doe",
"ship_to_phone": "+15551234567",
"ship_to_email": "jane@example.com",
"ship_to_address": "123 Main St, Springfield, IL 62704",
"reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reward_name": "Limited edition shirt",
"reward_image_url": "<string>",
"points_cost": 5000,
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_name": "Jane Doe"
}
],
"pagination": {
"page": 1,
"limit": 25,
"total": 37,
"total_pages": 2
}
}
}{
"success": false,
"error": {
"message": "Invalid API key"
}
}Authorizations
API key from the Rigaly dashboard: Authorization: Bearer rgly_sk_...
Query Parameters
Filter by lifecycle stage. Poll with pending to get the open queue.
Available options:
pending, shipped, delivered, cancelled Only redemptions of this reward.
Required range:
x >= 1Required range:
1 <= x <= 100