Skip to main content
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>",
  "is_hazmat": true,
  "hazmat_details": {},
  "accessorials": [
    "<string>"
  ],
  "declared_value": 123,
  "pallet_count": 123
}
'
{
  "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>",
  "status": "packing",
  "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",
  "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"
}

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

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

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
​
is_hazmat
boolean
​
hazmat_details
object
​
accessorials
string[]
​
declared_value
number
​
pallet_count
integer

Response

Updated package

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

​
id
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
​
shipped_at
string<date-time> | null
read-only
​
delivered_at
string<date-time> | null
read-only
​
metadata
object
​
created_at
string<date-time>
read-only
​
updated_at
string<date-time>
read-only