curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-priority-lists \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Flexport",
"lines": [
{
"warehouse_group_id": 1,
"fulfillment_channel_id": 11,
"order": 0,
"destination_oms_id": 3,
"destination_store_id": null
}
],
"description": "Primary routing",
"is_location_aware": false
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-priority-lists"
payload = {
"name": "Flexport",
"lines": [
{
"warehouse_group_id": 1,
"fulfillment_channel_id": 11,
"order": 0,
"destination_oms_id": 3,
"destination_store_id": None
}
],
"description": "Primary routing",
"is_location_aware": False
}
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({
name: 'Flexport',
lines: [
{
warehouse_group_id: 1,
fulfillment_channel_id: 11,
order: 0,
destination_oms_id: 3,
destination_store_id: null
}
],
description: 'Primary routing',
is_location_aware: false
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-priority-lists', 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/fulfillment-priority-lists",
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([
'name' => 'Flexport',
'lines' => [
[
'warehouse_group_id' => 1,
'fulfillment_channel_id' => 11,
'order' => 0,
'destination_oms_id' => 3,
'destination_store_id' => null
]
],
'description' => 'Primary routing',
'is_location_aware' => false
]),
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/fulfillment-priority-lists"
payload := strings.NewReader("{\n \"name\": \"Flexport\",\n \"lines\": [\n {\n \"warehouse_group_id\": 1,\n \"fulfillment_channel_id\": 11,\n \"order\": 0,\n \"destination_oms_id\": 3,\n \"destination_store_id\": null\n }\n ],\n \"description\": \"Primary routing\",\n \"is_location_aware\": false\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/fulfillment-priority-lists")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Flexport\",\n \"lines\": [\n {\n \"warehouse_group_id\": 1,\n \"fulfillment_channel_id\": 11,\n \"order\": 0,\n \"destination_oms_id\": 3,\n \"destination_store_id\": null\n }\n ],\n \"description\": \"Primary routing\",\n \"is_location_aware\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-priority-lists")
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 \"name\": \"Flexport\",\n \"lines\": [\n {\n \"warehouse_group_id\": 1,\n \"fulfillment_channel_id\": 11,\n \"order\": 0,\n \"destination_oms_id\": 3,\n \"destination_store_id\": null\n }\n ],\n \"description\": \"Primary routing\",\n \"is_location_aware\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 42,
"name": "Flexport",
"description": "Primary routing",
"is_location_aware": false,
"lines": [
{
"id": 101,
"order": 0,
"warehouse_group_id": 1,
"destination_oms_id": 3,
"destination_store_id": null,
"fulfillment_channel_id": 11,
"warehouse_group": {
"id": 123,
"label": "<string>"
},
"fulfillment_channel": {
"id": 123,
"label": "<string>"
},
"destination_oms": {
"id": 123,
"label": "<string>"
}
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"message": "<string>"
}{
"message": "<string>"
}Create a fulfillment priority list
Create a routing priority list with one or more ordered lines. destination_oms_id
maps to app_integration_accounts.id. A line’s warehouse_group_id may be omitted
only when the fulfillment channel defines a default warehouse group.
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-priority-lists \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Flexport",
"lines": [
{
"warehouse_group_id": 1,
"fulfillment_channel_id": 11,
"order": 0,
"destination_oms_id": 3,
"destination_store_id": null
}
],
"description": "Primary routing",
"is_location_aware": false
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-priority-lists"
payload = {
"name": "Flexport",
"lines": [
{
"warehouse_group_id": 1,
"fulfillment_channel_id": 11,
"order": 0,
"destination_oms_id": 3,
"destination_store_id": None
}
],
"description": "Primary routing",
"is_location_aware": False
}
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({
name: 'Flexport',
lines: [
{
warehouse_group_id: 1,
fulfillment_channel_id: 11,
order: 0,
destination_oms_id: 3,
destination_store_id: null
}
],
description: 'Primary routing',
is_location_aware: false
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-priority-lists', 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/fulfillment-priority-lists",
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([
'name' => 'Flexport',
'lines' => [
[
'warehouse_group_id' => 1,
'fulfillment_channel_id' => 11,
'order' => 0,
'destination_oms_id' => 3,
'destination_store_id' => null
]
],
'description' => 'Primary routing',
'is_location_aware' => false
]),
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/fulfillment-priority-lists"
payload := strings.NewReader("{\n \"name\": \"Flexport\",\n \"lines\": [\n {\n \"warehouse_group_id\": 1,\n \"fulfillment_channel_id\": 11,\n \"order\": 0,\n \"destination_oms_id\": 3,\n \"destination_store_id\": null\n }\n ],\n \"description\": \"Primary routing\",\n \"is_location_aware\": false\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/fulfillment-priority-lists")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Flexport\",\n \"lines\": [\n {\n \"warehouse_group_id\": 1,\n \"fulfillment_channel_id\": 11,\n \"order\": 0,\n \"destination_oms_id\": 3,\n \"destination_store_id\": null\n }\n ],\n \"description\": \"Primary routing\",\n \"is_location_aware\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-priority-lists")
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 \"name\": \"Flexport\",\n \"lines\": [\n {\n \"warehouse_group_id\": 1,\n \"fulfillment_channel_id\": 11,\n \"order\": 0,\n \"destination_oms_id\": 3,\n \"destination_store_id\": null\n }\n ],\n \"description\": \"Primary routing\",\n \"is_location_aware\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 42,
"name": "Flexport",
"description": "Primary routing",
"is_location_aware": false,
"lines": [
{
"id": 101,
"order": 0,
"warehouse_group_id": 1,
"destination_oms_id": 3,
"destination_store_id": null,
"fulfillment_channel_id": 11,
"warehouse_group": {
"id": 123,
"label": "<string>"
},
"fulfillment_channel": {
"id": 123,
"label": "<string>"
},
"destination_oms": {
"id": 123,
"label": "<string>"
}
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"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
Request body for creating or updating a fulfillment priority list.
Unique list name (per tenant, among non-deleted lists).
255"Flexport"
Ordered routing lines (at least one).
1Show child attributes
Show child attributes
"Primary routing"
When true, routing decisions take the order's location into account.
Response
Priority list created
A fulfillment priority list (routing priority list). Defines the ordered set of routing lines used to decide which warehouse group / fulfillment channel / destination OMS a sales order's fulfillment orders are routed to.
Show child attributes
Show child attributes