Skip to main content
GET
/
freight_orders
/
{id}
Retrieve a freight order with its quotes
curl --request GET \
  --url https://api.arcuserp.com/v1/freight_orders/{id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.arcuserp.com/v1/freight_orders/{id}"

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_orders/{id}', 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/{id}",
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/{id}"

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_orders/{id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

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

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": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "object": "order",
    "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "order_number": "<string>",
    "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "po_number": "<string>",
    "order_date": "2023-11-07T05:31:56Z",
    "due_date": "2023-11-07T05:31:56Z",
    "subtotal": 123,
    "discount_total": 123,
    "shipping_total": 123,
    "tax_total": 123,
    "fee_total": 123,
    "order_total": 123,
    "list_price_total": 123,
    "pricing_savings": 123,
    "amount_paid": 123,
    "balance_due": 123,
    "tax_exempt": true,
    "notes": "<string>",
    "internal_notes": "<string>",
    "invoice_number": "<string>",
    "is_on_hold": true,
    "hold_type": "<string>",
    "ship_complete": true,
    "source_platform": "<string>",
    "external_order_id": "<string>",
    "external_order_number": "<string>",
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "freight_quotes": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "carrier_name": "<string>",
        "carrier_service": "<string>",
        "quote_number": "<string>",
        "transit_days": 123,
        "amount": 123,
        "currency": "USD",
        "quoted_at": "2023-11-07T05:31:56Z",
        "expires_at": "2023-11-07T05:31:56Z",
        "accepted_at": "2023-11-07T05:31:56Z",
        "accepted_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "notes": "<string>",
        "raw_response": {},
        "created_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "metadata": {}
      }
    ]
  }
}
{
"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.

Path Parameters

id
string<uuid>
required

Response

Freight order with quotes

data
object

An Arcus ERP order document. One table holds quotes, sales_orders, invoices, returns, and purchase_orders -- always filter by document_type. entity_id is always from the API key (Layer 1 isolation).