Override an order's parcel/freight mode

curl --request POST \
  --url https://api.arcuserp.com/v1/freight_orders/{id}/override_mode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mode": "freight",
  "reason": "Total pallet weight 2,400 lb, parcel is non-viable."
}
'

import requests

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

payload = {
    "mode": "freight",
    "reason": "Total pallet weight 2,400 lb, parcel is non-viable."
}
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({mode: 'freight', reason: 'Total pallet weight 2,400 lb, parcel is non-viable.'})
};

fetch('https://api.arcuserp.com/v1/freight_orders/{id}/override_mode', 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}/override_mode",
  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([
    'mode' => 'freight',
    'reason' => 'Total pallet weight 2,400 lb, parcel is non-viable.'
  ]),
  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://api.arcuserp.com/v1/freight_orders/{id}/override_mode"

	payload := strings.NewReader("{\n  \"mode\": \"freight\",\n  \"reason\": \"Total pallet weight 2,400 lb, parcel is non-viable.\"\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://api.arcuserp.com/v1/freight_orders/{id}/override_mode")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"mode\": \"freight\",\n  \"reason\": \"Total pallet weight 2,400 lb, parcel is non-viable.\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"mode\": \"freight\",\n  \"reason\": \"Total pallet weight 2,400 lb, parcel is non-viable.\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reason": "<string>"
  }
}

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

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

Override an order's parcel/freight mode

Forces an order into or out of freight mode with a mandatory operator reason. Setting mode = 'freight' flips ships_freight = true and records the override attribution (freight_override_by_user_id, freight_override_reason); setting mode = 'parcel' clears the freight flag and disables freight-only sub-paths (BOL, freight packages, freight quote actions). The canonical handler audits via applyFreightOverride (no separate route-level activity log). Requires the orders:write scope.

POST

freight_orders

{id}

override_mode

Override an order's parcel/freight mode

curl --request POST \
  --url https://api.arcuserp.com/v1/freight_orders/{id}/override_mode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mode": "freight",
  "reason": "Total pallet weight 2,400 lb, parcel is non-viable."
}
'

import requests

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

payload = {
    "mode": "freight",
    "reason": "Total pallet weight 2,400 lb, parcel is non-viable."
}
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({mode: 'freight', reason: 'Total pallet weight 2,400 lb, parcel is non-viable.'})
};

fetch('https://api.arcuserp.com/v1/freight_orders/{id}/override_mode', 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}/override_mode",
  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([
    'mode' => 'freight',
    'reason' => 'Total pallet weight 2,400 lb, parcel is non-viable.'
  ]),
  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://api.arcuserp.com/v1/freight_orders/{id}/override_mode"

	payload := strings.NewReader("{\n  \"mode\": \"freight\",\n  \"reason\": \"Total pallet weight 2,400 lb, parcel is non-viable.\"\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://api.arcuserp.com/v1/freight_orders/{id}/override_mode")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"mode\": \"freight\",\n  \"reason\": \"Total pallet weight 2,400 lb, parcel is non-viable.\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"mode\": \"freight\",\n  \"reason\": \"Total pallet weight 2,400 lb, parcel is non-viable.\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reason": "<string>"
  }
}

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

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

string<uuid>

required

Body

application/json

mode

enum<string>

required

Available options:

parcel,

freight

Example:

"freight"

reason

string

required

Operator-supplied explanation (non-empty).

Example:

"Total pallet weight 2,400 lb, parcel is non-viable."

Response

Mode override applied

data

object

Show child attributes

Generate a tokenized Bill of Lading URL Create a freight package (pallet, crate, custom)

Overview

All Endpoints

Override an order's parcel/freight mode

Authorizations

Path Parameters

Body

Response