curl --request GET \
--url https://{companyName}.api.joinluminous.com/external/api/v1/returns \
--header 'Authorization: Bearer <token>'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/returns"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/returns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{companyName}.api.joinluminous.com/external/api/v1/returns",
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;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{companyName}.api.joinluminous.com/external/api/v1/returns"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{companyName}.api.joinluminous.com/external/api/v1/returns")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/returns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 123,
"sales_order_id": 123,
"status": "Pending",
"restock": true,
"order_date": "2023-12-25",
"refund_amount": 123,
"refunded_shipping": 123,
"tax_amount": 123,
"amount_paid": 123,
"product_total": 123,
"refund_date": "2023-12-25",
"transaction_type": "return-only",
"refund_id": 123,
"refund_total": 123,
"refund_tax": 123,
"refund_shipping": 123,
"refunded_at": "2023-11-07T05:31:56Z",
"is_deleted": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"items": [
{
"id": 123,
"sales_order_item_id": 123,
"sku": "<string>",
"quantity": 123,
"unit_price": 123,
"refunded_shipping": 123,
"tax_amount": 123,
"discount": 123,
"refund_date": "2023-12-25",
"refund_amount": 123,
"location_id": 123,
"lot_id": 123,
"external_restock_location_id": "<string>",
"lot_number": "<string>",
"lot_name": "<string>"
}
]
}
],
"meta": {}
}{
"message": "<string>"
}{
"message": "<string>"
}List customer returns
Paginated list of customer return orders, newest first (id descending).
Soft-deleted returns are excluded by default. Pass include_deleted=true (alias with_deleted)
to include them, or only_deleted=true to list only them; deleted returns carry is_deleted: true.
For detailed information about the filtering system and available operators, refer to the Filter System Documentation.
Available Filters
Enum Filters
status:PendingorReceived. Any other value returns422.
Boolean Filters
restock: Whether receiving the return restocks inventory
Integer Filters
sales_order_id: Originating sales order — matches returns linked directly to the sales order or through a refund order
DateTime Filters
created_at: When the return was createdupdated_at: When the return was last updated
Examples
# Pending returns for a sales order
?sales_order_id=12345&status=Pending
# Returns created since a date, including soft-deleted ones
?created_at[gte]=2026-01-01&include_deleted=true
curl --request GET \
--url https://{companyName}.api.joinluminous.com/external/api/v1/returns \
--header 'Authorization: Bearer <token>'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/returns"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/returns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{companyName}.api.joinluminous.com/external/api/v1/returns",
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;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{companyName}.api.joinluminous.com/external/api/v1/returns"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{companyName}.api.joinluminous.com/external/api/v1/returns")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/returns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 123,
"sales_order_id": 123,
"status": "Pending",
"restock": true,
"order_date": "2023-12-25",
"refund_amount": 123,
"refunded_shipping": 123,
"tax_amount": 123,
"amount_paid": 123,
"product_total": 123,
"refund_date": "2023-12-25",
"transaction_type": "return-only",
"refund_id": 123,
"refund_total": 123,
"refund_tax": 123,
"refund_shipping": 123,
"refunded_at": "2023-11-07T05:31:56Z",
"is_deleted": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"items": [
{
"id": 123,
"sales_order_item_id": 123,
"sku": "<string>",
"quantity": 123,
"unit_price": 123,
"refunded_shipping": 123,
"tax_amount": 123,
"discount": 123,
"refund_date": "2023-12-25",
"refund_amount": 123,
"location_id": 123,
"lot_id": 123,
"external_restock_location_id": "<string>",
"lot_number": "<string>",
"lot_name": "<string>"
}
]
}
],
"meta": {}
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Query Parameters
x >= 11 <= x <= 100Alias for per_page, used when per_page is not supplied.
1 <= x <= 100Filter by return status
Pending, Received Filter by whether receiving the return restocks inventory
Filter by originating sales order (direct, or nested under a refund order)
Filter by creation date
Filter by last update date
Include soft-deleted returns in the results. with_deleted is accepted as an alias.
Return only soft-deleted returns. Takes precedence over include_deleted.