Create a freight package (pallet, crate, custom)

curl --request POST \
  --url https://api.arcuserp.com/v1/freight_orders/{id}/packages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "package_type": "pallet",
  "freight_class": "100",
  "pallet_count": 2,
  "total_weight_lbs": 1200,
  "declared_value": 5400,
  "accessorials": [
    "LIFTGATE_DEL"
  ]
}
'

import requests

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

payload = {
    "package_type": "pallet",
    "freight_class": "100",
    "pallet_count": 2,
    "total_weight_lbs": 1200,
    "declared_value": 5400,
    "accessorials": ["LIFTGATE_DEL"]
}
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({
    package_type: 'pallet',
    freight_class: '100',
    pallet_count: 2,
    total_weight_lbs: 1200,
    declared_value: 5400,
    accessorials: ['LIFTGATE_DEL']
  })
};

fetch('https://api.arcuserp.com/v1/freight_orders/{id}/packages', 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}/packages",
  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([
    'package_type' => 'pallet',
    'freight_class' => '100',
    'pallet_count' => 2,
    'total_weight_lbs' => 1200,
    'declared_value' => 5400,
    'accessorials' => [
        'LIFTGATE_DEL'
    ]
  ]),
  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}/packages"

	payload := strings.NewReader("{\n  \"package_type\": \"pallet\",\n  \"freight_class\": \"100\",\n  \"pallet_count\": 2,\n  \"total_weight_lbs\": 1200,\n  \"declared_value\": 5400,\n  \"accessorials\": [\n    \"LIFTGATE_DEL\"\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://api.arcuserp.com/v1/freight_orders/{id}/packages")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"package_type\": \"pallet\",\n  \"freight_class\": \"100\",\n  \"pallet_count\": 2,\n  \"total_weight_lbs\": 1200,\n  \"declared_value\": 5400,\n  \"accessorials\": [\n    \"LIFTGATE_DEL\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"package_type\": \"pallet\",\n  \"freight_class\": \"100\",\n  \"pallet_count\": 2,\n  \"total_weight_lbs\": 1200,\n  \"declared_value\": 5400,\n  \"accessorials\": [\n    \"LIFTGATE_DEL\"\n  ]\n}"

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

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "package_type": "<string>",
    "freight_class": "<string>",
    "pallet_count": 123,
    "total_weight_lbs": 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"
}

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

Create a freight package (pallet, crate, custom)

Inserts a fulfillment.packages row tagged with freight-specific fields (NMFC class, NMFC code, pallet count, declared value, accessorials, dimensions). The order must already be flagged as freight (assertOrderIsFreight gate, returns 400 order_not_freight otherwise). The canonical handler emits an order.package_added realtime broadcast plus a freight.package_added activity log entry. Idempotent on Idempotency-Key. Requires the orders:write scope. Note: is_hazmat and hazmat_details removed 2026-05-22 (HAZMAT-SCRUB).

POST

freight_orders

{id}

packages

Create a freight package (pallet, crate, custom)

curl --request POST \
  --url https://api.arcuserp.com/v1/freight_orders/{id}/packages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "package_type": "pallet",
  "freight_class": "100",
  "pallet_count": 2,
  "total_weight_lbs": 1200,
  "declared_value": 5400,
  "accessorials": [
    "LIFTGATE_DEL"
  ]
}
'

import requests

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

payload = {
    "package_type": "pallet",
    "freight_class": "100",
    "pallet_count": 2,
    "total_weight_lbs": 1200,
    "declared_value": 5400,
    "accessorials": ["LIFTGATE_DEL"]
}
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({
    package_type: 'pallet',
    freight_class: '100',
    pallet_count: 2,
    total_weight_lbs: 1200,
    declared_value: 5400,
    accessorials: ['LIFTGATE_DEL']
  })
};

fetch('https://api.arcuserp.com/v1/freight_orders/{id}/packages', 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}/packages",
  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([
    'package_type' => 'pallet',
    'freight_class' => '100',
    'pallet_count' => 2,
    'total_weight_lbs' => 1200,
    'declared_value' => 5400,
    'accessorials' => [
        'LIFTGATE_DEL'
    ]
  ]),
  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}/packages"

	payload := strings.NewReader("{\n  \"package_type\": \"pallet\",\n  \"freight_class\": \"100\",\n  \"pallet_count\": 2,\n  \"total_weight_lbs\": 1200,\n  \"declared_value\": 5400,\n  \"accessorials\": [\n    \"LIFTGATE_DEL\"\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://api.arcuserp.com/v1/freight_orders/{id}/packages")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"package_type\": \"pallet\",\n  \"freight_class\": \"100\",\n  \"pallet_count\": 2,\n  \"total_weight_lbs\": 1200,\n  \"declared_value\": 5400,\n  \"accessorials\": [\n    \"LIFTGATE_DEL\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"package_type\": \"pallet\",\n  \"freight_class\": \"100\",\n  \"pallet_count\": 2,\n  \"total_weight_lbs\": 1200,\n  \"declared_value\": 5400,\n  \"accessorials\": [\n    \"LIFTGATE_DEL\"\n  ]\n}"

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

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "package_type": "<string>",
    "freight_class": "<string>",
    "pallet_count": 123,
    "total_weight_lbs": 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"
}

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

Headers

Idempotency-Key

string

Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours.

Maximum string length: 255

Path Parameters

string<uuid>

required

Body

application/json

package_type

enum<string>

default:pallet

Available options:

pallet,

crate,

custom

freight_class

string

NMFC freight class (50, 55, 60, 65, 70, 77.5, 85, 92.5, 100, 110, 125, 150, 175, 200, 250, 300, 400, 500).

Example:

"100"

nmfc_code

string | null

declared_value

number<float>

Required range: x >= 0

pallet_count

integer

Required range: x >= 1

Example:

2

total_weight_lbs

number<float>

Required range: x >= 0

Example:

1200

dimensions_json

object

Free-form pallet dimensions object (e.g. { length: 48, width: 40, height: 60 } in inches).

accessorials

string[]

Accessorial codes (LIFTGATE_DEL, INSIDE_DEL, RESIDENTIAL, NOTIFY, etc.).

carrier

string | null

service

string | null

items

object[]

Optional package_items rows to insert atomically with the package.

Show child attributes

Response

Freight package created

data

object

Show child attributes

Override an order's parcel/freight mode List freight quotes attached to an order

Overview

All Endpoints

Create a freight package (pallet, crate, custom)

Authorizations

Headers

Path Parameters

Body

Response