List freight orders (orders shipping via LTL/freight)

curl --request GET \
  --url https://api.arcuserp.com/v1/freight_orders \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.arcuserp.com/v1/freight_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://api.arcuserp.com/v1/freight_orders",
  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_orders"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/freight_orders")

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

{
  "object": "list",
  "data": [
    {
      "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"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>",
  "url": "/v1/freight_orders"
}

{
  "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 freight orders (orders shipping via LTL/freight)

Returns orders where delivery_option = 'freight' OR ships_freight = true, with a flattened summary of the currently-accepted freight quote (carrier, service, amount, currency, transit days, accepted_at) joined via a LATERAL subquery. Cursor pagination is stable on (created_at DESC, id DESC) and the opaque cursor is a base64-encoded { created_at, id }. Filters are AND-combined. Layer 1 entity isolation is enforced server-side from the API key; never trust a body-supplied entity_id. Requires the orders:read scope.

GET

freight_orders

curl --request GET \
  --url https://api.arcuserp.com/v1/freight_orders \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.arcuserp.com/v1/freight_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://api.arcuserp.com/v1/freight_orders",
  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_orders"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/freight_orders")

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

{
  "object": "list",
  "data": [
    {
      "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"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>",
  "url": "/v1/freight_orders"
}

{
  "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

Authorization

string

header

required

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

status

string

Filter by orders.status (draft / confirmed / fulfilled / invoiced / cancelled / archived).

location_id

string<uuid>

Filter by orders.location_id (Layer 4).

from_date

string<date>

Inclusive lower bound on created_at.

to_date

string<date>

Exclusive upper bound (created_at < to_date + 1 day).

freight_class

string

Filter by resolved NMFC freight class (50, 55, 60, ..., 500).

carrier_name

string

Substring match (case-insensitive) on the accepted quote's carrier_name.

limit

integer

default:50

Required range: 1 <= x <= 200

cursor

string

Opaque cursor from previous page (next_cursor).

Response

Freight order list envelope

object

string

Example:

"list"

data

object[]

Show child attributes

has_more

boolean

next_cursor

string | null

url

string

Example:

"/v1/freight_orders"

List the freight fulfillment Kanban (4 buckets)Retrieve a freight order with its quotes

Overview

All Endpoints

List freight orders (orders shipping via LTL/freight)

Authorizations

Query Parameters

Response