List the freight fulfillment Kanban (4 buckets)
curl --request GET \
--url https://api.arcuserp.com/v1/freight_fulfillment_queue \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.arcuserp.com/v1/freight_fulfillment_queue"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.arcuserp.com/v1/freight_fulfillment_queue', 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://api.arcuserp.com/v1/freight_fulfillment_queue",
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://api.arcuserp.com/v1/freight_fulfillment_queue"
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://api.arcuserp.com/v1/freight_fulfillment_queue")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/freight_fulfillment_queue")
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": {
"buckets": {
"quoting": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_type": "sales_order",
"status": "confirmed",
"delivery_option": "freight",
"ships_freight": true,
"freight_class_effective": "<string>",
"freight_reason": "<string>",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ship_to_name": "<string>",
"ship_to_address1": "<string>",
"ship_to_city": "<string>",
"ship_to_state": "<string>",
"ship_to_zip": "<string>",
"freight_quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"freight_carrier_name": "<string>",
"freight_carrier_service": "<string>",
"freight_quote_amount": 123,
"freight_quote_currency": "<string>",
"freight_transit_days": 123,
"freight_quote_accepted_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"ready_for_pickup": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_type": "sales_order",
"status": "confirmed",
"delivery_option": "freight",
"ships_freight": true,
"freight_class_effective": "<string>",
"freight_reason": "<string>",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ship_to_name": "<string>",
"ship_to_address1": "<string>",
"ship_to_city": "<string>",
"ship_to_state": "<string>",
"ship_to_zip": "<string>",
"freight_quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"freight_carrier_name": "<string>",
"freight_carrier_service": "<string>",
"freight_quote_amount": 123,
"freight_quote_currency": "<string>",
"freight_transit_days": 123,
"freight_quote_accepted_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"in_transit": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_type": "sales_order",
"status": "confirmed",
"delivery_option": "freight",
"ships_freight": true,
"freight_class_effective": "<string>",
"freight_reason": "<string>",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ship_to_name": "<string>",
"ship_to_address1": "<string>",
"ship_to_city": "<string>",
"ship_to_state": "<string>",
"ship_to_zip": "<string>",
"freight_quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"freight_carrier_name": "<string>",
"freight_carrier_service": "<string>",
"freight_quote_amount": 123,
"freight_quote_currency": "<string>",
"freight_transit_days": 123,
"freight_quote_accepted_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"delivered": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_type": "sales_order",
"status": "confirmed",
"delivery_option": "freight",
"ships_freight": true,
"freight_class_effective": "<string>",
"freight_reason": "<string>",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ship_to_name": "<string>",
"ship_to_address1": "<string>",
"ship_to_city": "<string>",
"ship_to_state": "<string>",
"ship_to_zip": "<string>",
"freight_quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"freight_carrier_name": "<string>",
"freight_carrier_service": "<string>",
"freight_quote_amount": 123,
"freight_quote_currency": "<string>",
"freight_transit_days": 123,
"freight_quote_accepted_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
},
"counts": {
"quoting": 123,
"ready_for_pickup": 123,
"in_transit": 123,
"delivered": 123
}
}
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}Freight
List the freight fulfillment Kanban (4 buckets)
Returns an entity-wide Kanban over open freight sales orders, bucketed by
progress: quoting (no accepted quote), ready_for_pickup (quote accepted,
no PRO yet), in_transit (PRO assigned), and delivered (any package row
has a delivered_at). Honors Layer 4 location scoping when the caller has
user_locations rows or supplies location_id. Cancelled and archived
orders are excluded. Each bucket entry carries the accepted carrier + amount
- PRO number + package count so the UI can render without a second round
trip. Requires the
orders:readscope.
GET
/
freight_fulfillment_queue
List the freight fulfillment Kanban (4 buckets)
curl --request GET \
--url https://api.arcuserp.com/v1/freight_fulfillment_queue \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.arcuserp.com/v1/freight_fulfillment_queue"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.arcuserp.com/v1/freight_fulfillment_queue', 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://api.arcuserp.com/v1/freight_fulfillment_queue",
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://api.arcuserp.com/v1/freight_fulfillment_queue"
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://api.arcuserp.com/v1/freight_fulfillment_queue")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/freight_fulfillment_queue")
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": {
"buckets": {
"quoting": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_type": "sales_order",
"status": "confirmed",
"delivery_option": "freight",
"ships_freight": true,
"freight_class_effective": "<string>",
"freight_reason": "<string>",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ship_to_name": "<string>",
"ship_to_address1": "<string>",
"ship_to_city": "<string>",
"ship_to_state": "<string>",
"ship_to_zip": "<string>",
"freight_quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"freight_carrier_name": "<string>",
"freight_carrier_service": "<string>",
"freight_quote_amount": 123,
"freight_quote_currency": "<string>",
"freight_transit_days": 123,
"freight_quote_accepted_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"ready_for_pickup": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_type": "sales_order",
"status": "confirmed",
"delivery_option": "freight",
"ships_freight": true,
"freight_class_effective": "<string>",
"freight_reason": "<string>",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ship_to_name": "<string>",
"ship_to_address1": "<string>",
"ship_to_city": "<string>",
"ship_to_state": "<string>",
"ship_to_zip": "<string>",
"freight_quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"freight_carrier_name": "<string>",
"freight_carrier_service": "<string>",
"freight_quote_amount": 123,
"freight_quote_currency": "<string>",
"freight_transit_days": 123,
"freight_quote_accepted_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"in_transit": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_type": "sales_order",
"status": "confirmed",
"delivery_option": "freight",
"ships_freight": true,
"freight_class_effective": "<string>",
"freight_reason": "<string>",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ship_to_name": "<string>",
"ship_to_address1": "<string>",
"ship_to_city": "<string>",
"ship_to_state": "<string>",
"ship_to_zip": "<string>",
"freight_quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"freight_carrier_name": "<string>",
"freight_carrier_service": "<string>",
"freight_quote_amount": 123,
"freight_quote_currency": "<string>",
"freight_transit_days": 123,
"freight_quote_accepted_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"delivered": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_type": "sales_order",
"status": "confirmed",
"delivery_option": "freight",
"ships_freight": true,
"freight_class_effective": "<string>",
"freight_reason": "<string>",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ship_to_name": "<string>",
"ship_to_address1": "<string>",
"ship_to_city": "<string>",
"ship_to_state": "<string>",
"ship_to_zip": "<string>",
"freight_quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"freight_carrier_name": "<string>",
"freight_carrier_service": "<string>",
"freight_quote_amount": 123,
"freight_quote_currency": "<string>",
"freight_transit_days": 123,
"freight_quote_accepted_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
},
"counts": {
"quoting": 123,
"ready_for_pickup": 123,
"in_transit": 123,
"delivered": 123
}
}
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}Authorizations
API key issued per entity via Settings > Developers > API Keys.
Each key carries scopes (e.g. orders:read, products:write).
Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.
Query Parameters
Optional warehouse scope (Layer 4). Returns only orders for this location plus location-unscoped orders.
Required range:
1 <= x <= 200Opaque cursor returned by the previous page.
Response
Freight Kanban
Show child attributes
Show child attributes
Was this page helpful?
⌘I