Create customer return
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/returns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sales_order_id": 123,
"items": [
{
"sales_order_item_id": 123,
"quantity": 1.001,
"uom_id": 123,
"location_id": 123,
"lot_id": 123,
"lot_number": "<string>",
"lot_name": "<string>"
}
],
"order_date": "2023-12-25",
"restock": true
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/returns"
payload = {
"sales_order_id": 123,
"items": [
{
"sales_order_item_id": 123,
"quantity": 1.001,
"uom_id": 123,
"location_id": 123,
"lot_id": 123,
"lot_number": "<string>",
"lot_name": "<string>"
}
],
"order_date": "2023-12-25",
"restock": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
sales_order_id: 123,
items: [
{
sales_order_item_id: 123,
quantity: 1.001,
uom_id: 123,
location_id: 123,
lot_id: 123,
lot_number: '<string>',
lot_name: '<string>'
}
],
order_date: '2023-12-25',
restock: true
})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'sales_order_id' => 123,
'items' => [
[
'sales_order_item_id' => 123,
'quantity' => 1.001,
'uom_id' => 123,
'location_id' => 123,
'lot_id' => 123,
'lot_number' => '<string>',
'lot_name' => '<string>'
]
],
'order_date' => '2023-12-25',
'restock' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{companyName}.api.joinluminous.com/external/api/v1/returns"
payload := strings.NewReader("{\n \"sales_order_id\": 123,\n \"items\": [\n {\n \"sales_order_item_id\": 123,\n \"quantity\": 1.001,\n \"uom_id\": 123,\n \"location_id\": 123,\n \"lot_id\": 123,\n \"lot_number\": \"<string>\",\n \"lot_name\": \"<string>\"\n }\n ],\n \"order_date\": \"2023-12-25\",\n \"restock\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{companyName}.api.joinluminous.com/external/api/v1/returns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sales_order_id\": 123,\n \"items\": [\n {\n \"sales_order_item_id\": 123,\n \"quantity\": 1.001,\n \"uom_id\": 123,\n \"location_id\": 123,\n \"lot_id\": 123,\n \"lot_number\": \"<string>\",\n \"lot_name\": \"<string>\"\n }\n ],\n \"order_date\": \"2023-12-25\",\n \"restock\": true\n}")
.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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sales_order_id\": 123,\n \"items\": [\n {\n \"sales_order_item_id\": 123,\n \"quantity\": 1.001,\n \"uom_id\": 123,\n \"location_id\": 123,\n \"lot_id\": 123,\n \"lot_number\": \"<string>\",\n \"lot_name\": \"<string>\"\n }\n ],\n \"order_date\": \"2023-12-25\",\n \"restock\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"sales_order_id": 123,
"restock": true,
"order_date": "2023-12-25",
"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,
"location_id": 123,
"lot_id": 123,
"lot_number": "<string>",
"lot_name": "<string>"
}
]
}
}{
"message": "<string>"
}{
"message": "<string>"
}Customer Returns
Create customer return
Create a new customer return against an existing sales order. Use transaction_type to control whether a
refund order is generated alongside the return:
return-only(default): just the return orderrefund-only: refund only, no return orderreturn-and-refund: both, linked
Returns are created in Pending status. Call PATCH /returns/{id}/receive to mark them received and
(optionally) restock inventory.
POST
/
returns
Create customer return
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/returns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sales_order_id": 123,
"items": [
{
"sales_order_item_id": 123,
"quantity": 1.001,
"uom_id": 123,
"location_id": 123,
"lot_id": 123,
"lot_number": "<string>",
"lot_name": "<string>"
}
],
"order_date": "2023-12-25",
"restock": true
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/returns"
payload = {
"sales_order_id": 123,
"items": [
{
"sales_order_item_id": 123,
"quantity": 1.001,
"uom_id": 123,
"location_id": 123,
"lot_id": 123,
"lot_number": "<string>",
"lot_name": "<string>"
}
],
"order_date": "2023-12-25",
"restock": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
sales_order_id: 123,
items: [
{
sales_order_item_id: 123,
quantity: 1.001,
uom_id: 123,
location_id: 123,
lot_id: 123,
lot_number: '<string>',
lot_name: '<string>'
}
],
order_date: '2023-12-25',
restock: true
})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'sales_order_id' => 123,
'items' => [
[
'sales_order_item_id' => 123,
'quantity' => 1.001,
'uom_id' => 123,
'location_id' => 123,
'lot_id' => 123,
'lot_number' => '<string>',
'lot_name' => '<string>'
]
],
'order_date' => '2023-12-25',
'restock' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{companyName}.api.joinluminous.com/external/api/v1/returns"
payload := strings.NewReader("{\n \"sales_order_id\": 123,\n \"items\": [\n {\n \"sales_order_item_id\": 123,\n \"quantity\": 1.001,\n \"uom_id\": 123,\n \"location_id\": 123,\n \"lot_id\": 123,\n \"lot_number\": \"<string>\",\n \"lot_name\": \"<string>\"\n }\n ],\n \"order_date\": \"2023-12-25\",\n \"restock\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{companyName}.api.joinluminous.com/external/api/v1/returns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sales_order_id\": 123,\n \"items\": [\n {\n \"sales_order_item_id\": 123,\n \"quantity\": 1.001,\n \"uom_id\": 123,\n \"location_id\": 123,\n \"lot_id\": 123,\n \"lot_number\": \"<string>\",\n \"lot_name\": \"<string>\"\n }\n ],\n \"order_date\": \"2023-12-25\",\n \"restock\": true\n}")
.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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sales_order_id\": 123,\n \"items\": [\n {\n \"sales_order_item_id\": 123,\n \"quantity\": 1.001,\n \"uom_id\": 123,\n \"location_id\": 123,\n \"lot_id\": 123,\n \"lot_number\": \"<string>\",\n \"lot_name\": \"<string>\"\n }\n ],\n \"order_date\": \"2023-12-25\",\n \"restock\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"sales_order_id": 123,
"restock": true,
"order_date": "2023-12-25",
"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,
"location_id": 123,
"lot_id": 123,
"lot_number": "<string>",
"lot_name": "<string>"
}
]
}
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Body
application/json
Minimum array length:
1Show child attributes
Show child attributes
Optional. When 1, the return is created already received.
Available options:
0, 1 When true, inventory is restocked on receive (default behavior).
Available options:
return-only, refund-only, return-and-refund Response
Created
A customer return for a sales order — return-only, refund-only, or return-and-refund. Status is Pending until received, then Received.
Show child attributes
Show child attributes
⌘I