Update package dimensions / metadata

curl --request PATCH \
  --url https://api.arcuserp.com/v1/packages/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "box_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "length": 123,
  "width": 123,
  "height": 123,
  "weight": 123,
  "notes": "<string>",
  "metadata": {},
  "freight_class": "<string>",
  "nmfc_code": "<string>",
  "accessorials": [
    "<string>"
  ],
  "declared_value": 123,
  "pallet_count": 123,
  "insurance_amount_override": 1
}
'

import requests

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

payload = {
    "box_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "length": 123,
    "width": 123,
    "height": 123,
    "weight": 123,
    "notes": "<string>",
    "metadata": {},
    "freight_class": "<string>",
    "nmfc_code": "<string>",
    "accessorials": ["<string>"],
    "declared_value": 123,
    "pallet_count": 123,
    "insurance_amount_override": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    box_product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    length: 123,
    width: 123,
    height: 123,
    weight: 123,
    notes: '<string>',
    metadata: {},
    freight_class: '<string>',
    nmfc_code: '<string>',
    accessorials: ['<string>'],
    declared_value: 123,
    pallet_count: 123,
    insurance_amount_override: 1
  })
};

fetch('https://api.arcuserp.com/v1/packages/{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/packages/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'box_product_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'length' => 123,
    'width' => 123,
    'height' => 123,
    'weight' => 123,
    'notes' => '<string>',
    'metadata' => [
        
    ],
    'freight_class' => '<string>',
    'nmfc_code' => '<string>',
    'accessorials' => [
        '<string>'
    ],
    'declared_value' => 123,
    'pallet_count' => 123,
    'insurance_amount_override' => 1
  ]),
  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/packages/{id}"

	payload := strings.NewReader("{\n  \"box_product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"length\": 123,\n  \"width\": 123,\n  \"height\": 123,\n  \"weight\": 123,\n  \"notes\": \"<string>\",\n  \"metadata\": {},\n  \"freight_class\": \"<string>\",\n  \"nmfc_code\": \"<string>\",\n  \"accessorials\": [\n    \"<string>\"\n  ],\n  \"declared_value\": 123,\n  \"pallet_count\": 123,\n  \"insurance_amount_override\": 1\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.arcuserp.com/v1/packages/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"box_product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"length\": 123,\n  \"width\": 123,\n  \"height\": 123,\n  \"weight\": 123,\n  \"notes\": \"<string>\",\n  \"metadata\": {},\n  \"freight_class\": \"<string>\",\n  \"nmfc_code\": \"<string>\",\n  \"accessorials\": [\n    \"<string>\"\n  ],\n  \"declared_value\": 123,\n  \"pallet_count\": 123,\n  \"insurance_amount_override\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"box_product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"length\": 123,\n  \"width\": 123,\n  \"height\": 123,\n  \"weight\": 123,\n  \"notes\": \"<string>\",\n  \"metadata\": {},\n  \"freight_class\": \"<string>\",\n  \"nmfc_code\": \"<string>\",\n  \"accessorials\": [\n    \"<string>\"\n  ],\n  \"declared_value\": 123,\n  \"pallet_count\": 123,\n  \"insurance_amount_override\": 1\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "package",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "package_number": "<string>",
  "weight_lb": 123,
  "length_in": 123,
  "width_in": 123,
  "height_in": 123,
  "carrier": "<string>",
  "service_level": "<string>",
  "tracking_number": "<string>",
  "tracking_url": "<string>",
  "ship_cost": 123,
  "billed_ship_cost": 123,
  "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "insurance_amount_override": 123,
  "insurance": {
    "active": true,
    "bought": true,
    "amount": 123,
    "currency": "<string>",
    "fee_estimate": 123,
    "provider": "<string>",
    "covered_items": [
      "<string>"
    ],
    "covered_item_count": 123
  },
  "shipped_at": "2023-11-07T05:31:56Z",
  "delivered_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

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

PATCH

packages

{id}

Update package dimensions / metadata

curl --request PATCH \
  --url https://api.arcuserp.com/v1/packages/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "box_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "length": 123,
  "width": 123,
  "height": 123,
  "weight": 123,
  "notes": "<string>",
  "metadata": {},
  "freight_class": "<string>",
  "nmfc_code": "<string>",
  "accessorials": [
    "<string>"
  ],
  "declared_value": 123,
  "pallet_count": 123,
  "insurance_amount_override": 1
}
'

import requests

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

payload = {
    "box_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "length": 123,
    "width": 123,
    "height": 123,
    "weight": 123,
    "notes": "<string>",
    "metadata": {},
    "freight_class": "<string>",
    "nmfc_code": "<string>",
    "accessorials": ["<string>"],
    "declared_value": 123,
    "pallet_count": 123,
    "insurance_amount_override": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    box_product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    length: 123,
    width: 123,
    height: 123,
    weight: 123,
    notes: '<string>',
    metadata: {},
    freight_class: '<string>',
    nmfc_code: '<string>',
    accessorials: ['<string>'],
    declared_value: 123,
    pallet_count: 123,
    insurance_amount_override: 1
  })
};

fetch('https://api.arcuserp.com/v1/packages/{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/packages/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'box_product_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'length' => 123,
    'width' => 123,
    'height' => 123,
    'weight' => 123,
    'notes' => '<string>',
    'metadata' => [
        
    ],
    'freight_class' => '<string>',
    'nmfc_code' => '<string>',
    'accessorials' => [
        '<string>'
    ],
    'declared_value' => 123,
    'pallet_count' => 123,
    'insurance_amount_override' => 1
  ]),
  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/packages/{id}"

	payload := strings.NewReader("{\n  \"box_product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"length\": 123,\n  \"width\": 123,\n  \"height\": 123,\n  \"weight\": 123,\n  \"notes\": \"<string>\",\n  \"metadata\": {},\n  \"freight_class\": \"<string>\",\n  \"nmfc_code\": \"<string>\",\n  \"accessorials\": [\n    \"<string>\"\n  ],\n  \"declared_value\": 123,\n  \"pallet_count\": 123,\n  \"insurance_amount_override\": 1\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.arcuserp.com/v1/packages/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"box_product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"length\": 123,\n  \"width\": 123,\n  \"height\": 123,\n  \"weight\": 123,\n  \"notes\": \"<string>\",\n  \"metadata\": {},\n  \"freight_class\": \"<string>\",\n  \"nmfc_code\": \"<string>\",\n  \"accessorials\": [\n    \"<string>\"\n  ],\n  \"declared_value\": 123,\n  \"pallet_count\": 123,\n  \"insurance_amount_override\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"box_product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"length\": 123,\n  \"width\": 123,\n  \"height\": 123,\n  \"weight\": 123,\n  \"notes\": \"<string>\",\n  \"metadata\": {},\n  \"freight_class\": \"<string>\",\n  \"nmfc_code\": \"<string>\",\n  \"accessorials\": [\n    \"<string>\"\n  ],\n  \"declared_value\": 123,\n  \"pallet_count\": 123,\n  \"insurance_amount_override\": 1\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "package",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "package_number": "<string>",
  "weight_lb": 123,
  "length_in": 123,
  "width_in": 123,
  "height_in": 123,
  "carrier": "<string>",
  "service_level": "<string>",
  "tracking_number": "<string>",
  "tracking_url": "<string>",
  "ship_cost": 123,
  "billed_ship_cost": 123,
  "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "insurance_amount_override": 123,
  "insurance": {
    "active": true,
    "bought": true,
    "amount": 123,
    "currency": "<string>",
    "fee_estimate": 123,
    "provider": "<string>",
    "covered_items": [
      "<string>"
    ],
    "covered_item_count": 123
  },
  "shipped_at": "2023-11-07T05:31:56Z",
  "delivered_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

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

box_product_id

string<uuid>

length

number

width

number

height

number

weight

number

notes

string

metadata

object

freight_class

string

nmfc_code

string

accessorials

string[]

declared_value

number

pallet_count

integer

insurance_amount_override

number | null

Manual override of the auto-computed insured declared value for Shippo freight insurance. When set (> 0), this amount wins over the value derived from products with apply_freight_insurance = true and the entity insurance threshold. Send null to clear the override and fall back to auto-computation. The carrier insurance cap still applies. Use for high-value items worth more than their list price.

Required range: x >= 0

Response

Updated package

A shipment / box created during fulfillment. One package contains many package items (line item splits) and at most one shipment label.

string<uuid>

object

enum<string>

Available options:

package

entity_id

string<uuid>

read-only

order_id

string<uuid>

package_number

string

read-only

Sequential per entity.

status

enum<string>

read-only

Available options:

packing,

packed,

labeled,

shipped,

delivered,

returned,

void

weight_lb

number | null

length_in

number | null

width_in

number | null

height_in

number | null

carrier

string | null

e.g. ups, usps, fedex, dhl.

service_level

string | null

e.g. ground, priority, 2day.

tracking_number

string | null

tracking_url

string | null

ship_cost

number | null

billed_ship_cost

number | null

Cost billed to customer (vs purchased cost).

location_id

string<uuid> | null

insurance_amount_override

number | null

Manual override of the auto-computed Shippo-insurance declared value. When set, overrides the value derived from products flagged apply_freight_insurance.

insurance

object | null

read-only

Auto-insurance summary. null when no package item opts in and there is no override / entity threshold. bought: true after a label has been purchased (amount = the value actually insured at Shippo); bought: false projects what the next label purchase will insure.

Show child attributes

shipped_at

string<date-time> | null

read-only

delivered_at

string<date-time> | null

read-only

metadata

object | null

created_at

string<date-time>

read-only

updated_at

string<date-time>

read-only

Delete a package (auto-voids active label)Add an order item to a package