Create freight shipment and request quotes
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/freight/quotes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"pickup_date": "2026-10-22",
"items": [
{
"quantity": 1,
"weight": 1911,
"freight_class": 55,
"type": "pallet",
"length": 74,
"width": 40,
"height": 21,
"nmfc_number": "37860",
"stackable": false,
"pieces": 36,
"contents": "36 x Nakan Signature / Micro / Box"
}
]
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/freight/quotes"
payload = {
"pickup_date": "2026-10-22",
"items": [
{
"quantity": 1,
"weight": 1911,
"freight_class": 55,
"type": "pallet",
"length": 74,
"width": 40,
"height": 21,
"nmfc_number": "37860",
"stackable": False,
"pieces": 36,
"contents": "36 x Nakan Signature / Micro / Box"
}
]
}
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({
pickup_date: '2026-10-22',
items: [
{
quantity: 1,
weight: 1911,
freight_class: 55,
type: 'pallet',
length: 74,
width: 40,
height: 21,
nmfc_number: '37860',
stackable: false,
pieces: 36,
contents: '36 x Nakan Signature / Micro / Box'
}
]
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/freight/quotes', 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-orders/{fulfillmentOrderId}/freight/quotes",
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([
'pickup_date' => '2026-10-22',
'items' => [
[
'quantity' => 1,
'weight' => 1911,
'freight_class' => 55,
'type' => 'pallet',
'length' => 74,
'width' => 40,
'height' => 21,
'nmfc_number' => '37860',
'stackable' => false,
'pieces' => 36,
'contents' => '36 x Nakan Signature / Micro / Box'
]
]
]),
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-orders/{fulfillmentOrderId}/freight/quotes"
payload := strings.NewReader("{\n \"pickup_date\": \"2026-10-22\",\n \"items\": [\n {\n \"quantity\": 1,\n \"weight\": 1911,\n \"freight_class\": 55,\n \"type\": \"pallet\",\n \"length\": 74,\n \"width\": 40,\n \"height\": 21,\n \"nmfc_number\": \"37860\",\n \"stackable\": false,\n \"pieces\": 36,\n \"contents\": \"36 x Nakan Signature / Micro / Box\"\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/fulfillment-orders/{fulfillmentOrderId}/freight/quotes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"pickup_date\": \"2026-10-22\",\n \"items\": [\n {\n \"quantity\": 1,\n \"weight\": 1911,\n \"freight_class\": 55,\n \"type\": \"pallet\",\n \"length\": 74,\n \"width\": 40,\n \"height\": 21,\n \"nmfc_number\": \"37860\",\n \"stackable\": false,\n \"pieces\": 36,\n \"contents\": \"36 x Nakan Signature / Micro / Box\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/freight/quotes")
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 \"pickup_date\": \"2026-10-22\",\n \"items\": [\n {\n \"quantity\": 1,\n \"weight\": 1911,\n \"freight_class\": 55,\n \"type\": \"pallet\",\n \"length\": 74,\n \"width\": 40,\n \"height\": 21,\n \"nmfc_number\": \"37860\",\n \"stackable\": false,\n \"pieces\": 36,\n \"contents\": \"36 x Nakan Signature / Micro / Box\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"provider": "freightview",
"providerShipmentId": "<string>",
"shipstationShipmentId": 123,
"fulfillmentOrderId": 123,
"appIntegrationAccountId": 123,
"providerStatus": "<string>",
"selectedQuoteId": "<string>",
"pickupConfirmation": "<string>",
"bolNumber": "<string>",
"proNumber": "<string>",
"carrierScac": "<string>",
"trackingNumber": "<string>",
"serviceCode": "<string>",
"shipmentCost": 123,
"pickupDate": "2023-12-25",
"pickupWindowStart": "<string>",
"pickupWindowEnd": "<string>",
"errorMessage": "<string>",
"bookedAt": "2023-11-07T05:31:56Z",
"pollingStatus": "<string>",
"pollingStartedAt": "2023-11-07T05:31:56Z",
"pollingCompletedAt": "2023-11-07T05:31:56Z",
"originAddress": {},
"destinationAddress": {},
"freightItems": [
{}
],
"originLocationType": "business_dock",
"destinationLocationType": "business_dock",
"destinationAccessorials": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"quotes": [
{
"id": 123,
"providerQuoteId": "<string>",
"carrier": "<string>",
"carrierScac": "<string>",
"service": "<string>",
"price": 123,
"transitDaysMin": 123,
"transitDaysMax": 123,
"isSelected": true,
"isAppointment": true,
"expiresAt": "2023-11-07T05:31:56Z",
"status": "<string>",
"errors": [
"<string>"
]
}
],
"documents": [
{
"id": 123,
"documentType": "<string>",
"fileName": "<string>",
"fileUrl": "<string>",
"providerUrl": "<string>",
"mimeType": "<string>"
}
]
}
}{
"error": "At least one freight item is required."
}{
"message": "<string>"
}{
"message": "No default Freightview account for this fulfillment order; send app_integration_account_id."
}Fulfillment Orders
Create freight shipment and request quotes
Create a Freightview LTL shipment for the fulfillment order and start rating. The response is the new
freight record (id is the metadataId for the /freight/shipments/{metadataId} routes); poll
GET /freight/shipments/{metadataId}/quotes until polling_status is completed, then book with
POST /freight/shipments/{metadataId}/book.
Every call creates another Freightview shipment. Check
GET /fulfillment-orders/{id}/freight/shipments first and reuse an open session (bookedAt: null).
What the web app pre-fills is optional here: origin defaults to the order’s warehouse group address,
destination to the order’s ship-to, and app_integration_account_id to the account from
GET /fulfillment-orders/{id}/freight/defaults (422 when none resolves). An address that is
sent must be complete. items is required — send the package plan’s freight_items.
Validation failures use the 400 {"error": "..."} shape.
POST
/
fulfillment-orders
/
{fulfillmentOrderId}
/
freight
/
quotes
Create freight shipment and request quotes
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/freight/quotes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"pickup_date": "2026-10-22",
"items": [
{
"quantity": 1,
"weight": 1911,
"freight_class": 55,
"type": "pallet",
"length": 74,
"width": 40,
"height": 21,
"nmfc_number": "37860",
"stackable": false,
"pieces": 36,
"contents": "36 x Nakan Signature / Micro / Box"
}
]
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/freight/quotes"
payload = {
"pickup_date": "2026-10-22",
"items": [
{
"quantity": 1,
"weight": 1911,
"freight_class": 55,
"type": "pallet",
"length": 74,
"width": 40,
"height": 21,
"nmfc_number": "37860",
"stackable": False,
"pieces": 36,
"contents": "36 x Nakan Signature / Micro / Box"
}
]
}
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({
pickup_date: '2026-10-22',
items: [
{
quantity: 1,
weight: 1911,
freight_class: 55,
type: 'pallet',
length: 74,
width: 40,
height: 21,
nmfc_number: '37860',
stackable: false,
pieces: 36,
contents: '36 x Nakan Signature / Micro / Box'
}
]
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/freight/quotes', 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-orders/{fulfillmentOrderId}/freight/quotes",
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([
'pickup_date' => '2026-10-22',
'items' => [
[
'quantity' => 1,
'weight' => 1911,
'freight_class' => 55,
'type' => 'pallet',
'length' => 74,
'width' => 40,
'height' => 21,
'nmfc_number' => '37860',
'stackable' => false,
'pieces' => 36,
'contents' => '36 x Nakan Signature / Micro / Box'
]
]
]),
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-orders/{fulfillmentOrderId}/freight/quotes"
payload := strings.NewReader("{\n \"pickup_date\": \"2026-10-22\",\n \"items\": [\n {\n \"quantity\": 1,\n \"weight\": 1911,\n \"freight_class\": 55,\n \"type\": \"pallet\",\n \"length\": 74,\n \"width\": 40,\n \"height\": 21,\n \"nmfc_number\": \"37860\",\n \"stackable\": false,\n \"pieces\": 36,\n \"contents\": \"36 x Nakan Signature / Micro / Box\"\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/fulfillment-orders/{fulfillmentOrderId}/freight/quotes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"pickup_date\": \"2026-10-22\",\n \"items\": [\n {\n \"quantity\": 1,\n \"weight\": 1911,\n \"freight_class\": 55,\n \"type\": \"pallet\",\n \"length\": 74,\n \"width\": 40,\n \"height\": 21,\n \"nmfc_number\": \"37860\",\n \"stackable\": false,\n \"pieces\": 36,\n \"contents\": \"36 x Nakan Signature / Micro / Box\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/freight/quotes")
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 \"pickup_date\": \"2026-10-22\",\n \"items\": [\n {\n \"quantity\": 1,\n \"weight\": 1911,\n \"freight_class\": 55,\n \"type\": \"pallet\",\n \"length\": 74,\n \"width\": 40,\n \"height\": 21,\n \"nmfc_number\": \"37860\",\n \"stackable\": false,\n \"pieces\": 36,\n \"contents\": \"36 x Nakan Signature / Micro / Box\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"provider": "freightview",
"providerShipmentId": "<string>",
"shipstationShipmentId": 123,
"fulfillmentOrderId": 123,
"appIntegrationAccountId": 123,
"providerStatus": "<string>",
"selectedQuoteId": "<string>",
"pickupConfirmation": "<string>",
"bolNumber": "<string>",
"proNumber": "<string>",
"carrierScac": "<string>",
"trackingNumber": "<string>",
"serviceCode": "<string>",
"shipmentCost": 123,
"pickupDate": "2023-12-25",
"pickupWindowStart": "<string>",
"pickupWindowEnd": "<string>",
"errorMessage": "<string>",
"bookedAt": "2023-11-07T05:31:56Z",
"pollingStatus": "<string>",
"pollingStartedAt": "2023-11-07T05:31:56Z",
"pollingCompletedAt": "2023-11-07T05:31:56Z",
"originAddress": {},
"destinationAddress": {},
"freightItems": [
{}
],
"originLocationType": "business_dock",
"destinationLocationType": "business_dock",
"destinationAccessorials": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"quotes": [
{
"id": 123,
"providerQuoteId": "<string>",
"carrier": "<string>",
"carrierScac": "<string>",
"service": "<string>",
"price": 123,
"transitDaysMin": 123,
"transitDaysMax": 123,
"isSelected": true,
"isAppointment": true,
"expiresAt": "2023-11-07T05:31:56Z",
"status": "<string>",
"errors": [
"<string>"
]
}
],
"documents": [
{
"id": 123,
"documentType": "<string>",
"fileName": "<string>",
"fileUrl": "<string>",
"providerUrl": "<string>",
"mimeType": "<string>"
}
]
}
}{
"error": "At least one freight item is required."
}{
"message": "<string>"
}{
"message": "No default Freightview account for this fulfillment order; send app_integration_account_id."
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Path Parameters
ID of the fulfillment order
Body
application/json
Today or later.
Minimum array length:
1Show child attributes
Show child attributes
24-hour HH:MM. Send both window fields or neither; end must be after start.
Freightview integration account. Defaults to the order's resolved account.
Defaults to the order's warehouse group. Must be complete when sent (including contact_name and contact_phone).
Show child attributes
Show child attributes
Defaults to the order's ship-to. Must be complete when sent.
Show child attributes
Show child attributes
Existing Luminous shipment to attach the freight record to.
Available options:
business_dock, business_no_dock, residential Available options:
business_dock, business_no_dock, residential call_before and appointment cannot be combined.
Available options:
liftgate, inside_delivery, call_before, appointment, sort_segregate, protect_from_freezing Response
Freight shipment created; rating in progress
A Freightview freight shipment record ("metadata") for a fulfillment order: the quote session and, once
booked, the booking references. Field names are camelCase. quotes and documents are present when loaded
(single-record and fulfillment-order reads load quotes).
Show child attributes
Show child attributes