Create a transfer order
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/transfer-orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"date": "2023-12-25",
"arrival_date": "2023-12-25",
"shipping_cost": 123,
"source_warehouse_id": 123,
"destination_warehouse_id": 123,
"items": [
{
"quantity": 123,
"ordered_uom_id": 123,
"product_id": 123,
"lot_id": 123,
"lot_number": "<string>",
"lot_name": "<string>"
}
],
"number": "<string>",
"items_cost": 123,
"shipping_method": "<string>",
"channel_id": 123,
"note": "<string>",
"auto_receive_order_on_arrival": true,
"extra_costs": [
{
"name": "<string>",
"unit_price": 1,
"quantity": 1,
"reference_number": "<string>"
}
]
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/transfer-orders"
payload = {
"date": "2023-12-25",
"arrival_date": "2023-12-25",
"shipping_cost": 123,
"source_warehouse_id": 123,
"destination_warehouse_id": 123,
"items": [
{
"quantity": 123,
"ordered_uom_id": 123,
"product_id": 123,
"lot_id": 123,
"lot_number": "<string>",
"lot_name": "<string>"
}
],
"number": "<string>",
"items_cost": 123,
"shipping_method": "<string>",
"channel_id": 123,
"note": "<string>",
"auto_receive_order_on_arrival": True,
"extra_costs": [
{
"name": "<string>",
"unit_price": 1,
"quantity": 1,
"reference_number": "<string>"
}
]
}
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({
date: '2023-12-25',
arrival_date: '2023-12-25',
shipping_cost: 123,
source_warehouse_id: 123,
destination_warehouse_id: 123,
items: [
{
quantity: 123,
ordered_uom_id: 123,
product_id: 123,
lot_id: 123,
lot_number: '<string>',
lot_name: '<string>'
}
],
number: '<string>',
items_cost: 123,
shipping_method: '<string>',
channel_id: 123,
note: '<string>',
auto_receive_order_on_arrival: true,
extra_costs: [{name: '<string>', unit_price: 1, quantity: 1, reference_number: '<string>'}]
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/transfer-orders', 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/transfer-orders",
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([
'date' => '2023-12-25',
'arrival_date' => '2023-12-25',
'shipping_cost' => 123,
'source_warehouse_id' => 123,
'destination_warehouse_id' => 123,
'items' => [
[
'quantity' => 123,
'ordered_uom_id' => 123,
'product_id' => 123,
'lot_id' => 123,
'lot_number' => '<string>',
'lot_name' => '<string>'
]
],
'number' => '<string>',
'items_cost' => 123,
'shipping_method' => '<string>',
'channel_id' => 123,
'note' => '<string>',
'auto_receive_order_on_arrival' => true,
'extra_costs' => [
[
'name' => '<string>',
'unit_price' => 1,
'quantity' => 1,
'reference_number' => '<string>'
]
]
]),
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/transfer-orders"
payload := strings.NewReader("{\n \"date\": \"2023-12-25\",\n \"arrival_date\": \"2023-12-25\",\n \"shipping_cost\": 123,\n \"source_warehouse_id\": 123,\n \"destination_warehouse_id\": 123,\n \"items\": [\n {\n \"quantity\": 123,\n \"ordered_uom_id\": 123,\n \"product_id\": 123,\n \"lot_id\": 123,\n \"lot_number\": \"<string>\",\n \"lot_name\": \"<string>\"\n }\n ],\n \"number\": \"<string>\",\n \"items_cost\": 123,\n \"shipping_method\": \"<string>\",\n \"channel_id\": 123,\n \"note\": \"<string>\",\n \"auto_receive_order_on_arrival\": true,\n \"extra_costs\": [\n {\n \"name\": \"<string>\",\n \"unit_price\": 1,\n \"quantity\": 1,\n \"reference_number\": \"<string>\"\n }\n ]\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/transfer-orders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"date\": \"2023-12-25\",\n \"arrival_date\": \"2023-12-25\",\n \"shipping_cost\": 123,\n \"source_warehouse_id\": 123,\n \"destination_warehouse_id\": 123,\n \"items\": [\n {\n \"quantity\": 123,\n \"ordered_uom_id\": 123,\n \"product_id\": 123,\n \"lot_id\": 123,\n \"lot_number\": \"<string>\",\n \"lot_name\": \"<string>\"\n }\n ],\n \"number\": \"<string>\",\n \"items_cost\": 123,\n \"shipping_method\": \"<string>\",\n \"channel_id\": 123,\n \"note\": \"<string>\",\n \"auto_receive_order_on_arrival\": true,\n \"extra_costs\": [\n {\n \"name\": \"<string>\",\n \"unit_price\": 1,\n \"quantity\": 1,\n \"reference_number\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/transfer-orders")
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 \"date\": \"2023-12-25\",\n \"arrival_date\": \"2023-12-25\",\n \"shipping_cost\": 123,\n \"source_warehouse_id\": 123,\n \"destination_warehouse_id\": 123,\n \"items\": [\n {\n \"quantity\": 123,\n \"ordered_uom_id\": 123,\n \"product_id\": 123,\n \"lot_id\": 123,\n \"lot_number\": \"<string>\",\n \"lot_name\": \"<string>\"\n }\n ],\n \"number\": \"<string>\",\n \"items_cost\": 123,\n \"shipping_method\": \"<string>\",\n \"channel_id\": 123,\n \"note\": \"<string>\",\n \"auto_receive_order_on_arrival\": true,\n \"extra_costs\": [\n {\n \"name\": \"<string>\",\n \"unit_price\": 1,\n \"quantity\": 1,\n \"reference_number\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"number": "<string>",
"date": "2023-12-25",
"arrival_date": "2023-12-25",
"items_cost": 123,
"shipping_cost": 123,
"shipping_method": "<string>",
"source_warehouse_id": 123,
"destination_warehouse_id": 123,
"channel_id": 123,
"note": "<string>",
"sales_order_id": 123,
"purchase_order_id": 123,
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"items": [
{
"id": 123,
"transfer_order_id": 123,
"product_id": 123,
"sku": "<string>",
"product_name": "<string>",
"description": "<string>",
"quantity": 123,
"ordered_qty": 123,
"base_uom_id": 123,
"ordered_uom_id": 123,
"unit_cost": 123,
"line_item_cost": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"extra_costs": [
{
"id": 123,
"name": "<string>",
"cost_type": "freight",
"reference_number": "<string>",
"quantity": 123,
"unit_price": 123,
"line_total": 123,
"cost_allocation_type": "UNIT_BASED_ALLOCATION"
}
]
}
}{
"message": "<string>"
}{
"error": "<string>"
}Transfer Orders
Create a transfer order
Create a new transfer order. Send status: DRAFT to create a draft you can edit with PUT /transfer-orders/{id} and post later with POST /transfer-orders/{id}/post, or status: POSTED to post it immediately.
POST
/
transfer-orders
Create a transfer order
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/transfer-orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"date": "2023-12-25",
"arrival_date": "2023-12-25",
"shipping_cost": 123,
"source_warehouse_id": 123,
"destination_warehouse_id": 123,
"items": [
{
"quantity": 123,
"ordered_uom_id": 123,
"product_id": 123,
"lot_id": 123,
"lot_number": "<string>",
"lot_name": "<string>"
}
],
"number": "<string>",
"items_cost": 123,
"shipping_method": "<string>",
"channel_id": 123,
"note": "<string>",
"auto_receive_order_on_arrival": true,
"extra_costs": [
{
"name": "<string>",
"unit_price": 1,
"quantity": 1,
"reference_number": "<string>"
}
]
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/transfer-orders"
payload = {
"date": "2023-12-25",
"arrival_date": "2023-12-25",
"shipping_cost": 123,
"source_warehouse_id": 123,
"destination_warehouse_id": 123,
"items": [
{
"quantity": 123,
"ordered_uom_id": 123,
"product_id": 123,
"lot_id": 123,
"lot_number": "<string>",
"lot_name": "<string>"
}
],
"number": "<string>",
"items_cost": 123,
"shipping_method": "<string>",
"channel_id": 123,
"note": "<string>",
"auto_receive_order_on_arrival": True,
"extra_costs": [
{
"name": "<string>",
"unit_price": 1,
"quantity": 1,
"reference_number": "<string>"
}
]
}
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({
date: '2023-12-25',
arrival_date: '2023-12-25',
shipping_cost: 123,
source_warehouse_id: 123,
destination_warehouse_id: 123,
items: [
{
quantity: 123,
ordered_uom_id: 123,
product_id: 123,
lot_id: 123,
lot_number: '<string>',
lot_name: '<string>'
}
],
number: '<string>',
items_cost: 123,
shipping_method: '<string>',
channel_id: 123,
note: '<string>',
auto_receive_order_on_arrival: true,
extra_costs: [{name: '<string>', unit_price: 1, quantity: 1, reference_number: '<string>'}]
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/transfer-orders', 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/transfer-orders",
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([
'date' => '2023-12-25',
'arrival_date' => '2023-12-25',
'shipping_cost' => 123,
'source_warehouse_id' => 123,
'destination_warehouse_id' => 123,
'items' => [
[
'quantity' => 123,
'ordered_uom_id' => 123,
'product_id' => 123,
'lot_id' => 123,
'lot_number' => '<string>',
'lot_name' => '<string>'
]
],
'number' => '<string>',
'items_cost' => 123,
'shipping_method' => '<string>',
'channel_id' => 123,
'note' => '<string>',
'auto_receive_order_on_arrival' => true,
'extra_costs' => [
[
'name' => '<string>',
'unit_price' => 1,
'quantity' => 1,
'reference_number' => '<string>'
]
]
]),
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/transfer-orders"
payload := strings.NewReader("{\n \"date\": \"2023-12-25\",\n \"arrival_date\": \"2023-12-25\",\n \"shipping_cost\": 123,\n \"source_warehouse_id\": 123,\n \"destination_warehouse_id\": 123,\n \"items\": [\n {\n \"quantity\": 123,\n \"ordered_uom_id\": 123,\n \"product_id\": 123,\n \"lot_id\": 123,\n \"lot_number\": \"<string>\",\n \"lot_name\": \"<string>\"\n }\n ],\n \"number\": \"<string>\",\n \"items_cost\": 123,\n \"shipping_method\": \"<string>\",\n \"channel_id\": 123,\n \"note\": \"<string>\",\n \"auto_receive_order_on_arrival\": true,\n \"extra_costs\": [\n {\n \"name\": \"<string>\",\n \"unit_price\": 1,\n \"quantity\": 1,\n \"reference_number\": \"<string>\"\n }\n ]\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/transfer-orders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"date\": \"2023-12-25\",\n \"arrival_date\": \"2023-12-25\",\n \"shipping_cost\": 123,\n \"source_warehouse_id\": 123,\n \"destination_warehouse_id\": 123,\n \"items\": [\n {\n \"quantity\": 123,\n \"ordered_uom_id\": 123,\n \"product_id\": 123,\n \"lot_id\": 123,\n \"lot_number\": \"<string>\",\n \"lot_name\": \"<string>\"\n }\n ],\n \"number\": \"<string>\",\n \"items_cost\": 123,\n \"shipping_method\": \"<string>\",\n \"channel_id\": 123,\n \"note\": \"<string>\",\n \"auto_receive_order_on_arrival\": true,\n \"extra_costs\": [\n {\n \"name\": \"<string>\",\n \"unit_price\": 1,\n \"quantity\": 1,\n \"reference_number\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/transfer-orders")
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 \"date\": \"2023-12-25\",\n \"arrival_date\": \"2023-12-25\",\n \"shipping_cost\": 123,\n \"source_warehouse_id\": 123,\n \"destination_warehouse_id\": 123,\n \"items\": [\n {\n \"quantity\": 123,\n \"ordered_uom_id\": 123,\n \"product_id\": 123,\n \"lot_id\": 123,\n \"lot_number\": \"<string>\",\n \"lot_name\": \"<string>\"\n }\n ],\n \"number\": \"<string>\",\n \"items_cost\": 123,\n \"shipping_method\": \"<string>\",\n \"channel_id\": 123,\n \"note\": \"<string>\",\n \"auto_receive_order_on_arrival\": true,\n \"extra_costs\": [\n {\n \"name\": \"<string>\",\n \"unit_price\": 1,\n \"quantity\": 1,\n \"reference_number\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"number": "<string>",
"date": "2023-12-25",
"arrival_date": "2023-12-25",
"items_cost": 123,
"shipping_cost": 123,
"shipping_method": "<string>",
"source_warehouse_id": 123,
"destination_warehouse_id": 123,
"channel_id": 123,
"note": "<string>",
"sales_order_id": 123,
"purchase_order_id": 123,
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"items": [
{
"id": 123,
"transfer_order_id": 123,
"product_id": 123,
"sku": "<string>",
"product_name": "<string>",
"description": "<string>",
"quantity": 123,
"ordered_qty": 123,
"base_uom_id": 123,
"ordered_uom_id": 123,
"unit_cost": 123,
"line_item_cost": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"extra_costs": [
{
"id": 123,
"name": "<string>",
"cost_type": "freight",
"reference_number": "<string>",
"quantity": 123,
"unit_price": 123,
"line_total": 123,
"cost_allocation_type": "UNIT_BASED_ALLOCATION"
}
]
}
}{
"message": "<string>"
}{
"error": "<string>"
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Body
application/json
Date of the transfer order
Expected arrival date
Shipping cost
ID of the source warehouse
ID of the destination warehouse
Status of the transfer order
Available options:
DRAFT, POSTED Show child attributes
Show child attributes
Transfer order number. Must be unique across transfer orders.
Total cost of items
Method of shipping. Optional — if omitted or empty, defaults to "Standard".
ID of the fulfillment source channel. Posting uses it for the sales order the transfer order creates, so that sales order can generate fulfillment orders.
Note on the transfer order
Automatically receive the transfer order when it arrives
Extra costs (freight, duty, ...) for the transfer. When the transfer order is posted, each extra cost is copied onto its purchase order, prorated onto its receiving reports, and added to the landed cost of the received units. Separate from shipping_cost, which is unchanged. Line filters (category_ids, tag_ids, internal_skus, supplier_skus) are not supported and are rejected.
Show child attributes
Show child attributes
Response
Successful response
Show child attributes
Show child attributes