Update package dimensions / metadata

Updates header-level fields on a package in status: draft (dimensions, weight, carrier preference, reference number). Once a label has been purchased, dimension and carrier fields are locked; call changePackageBox or changePackageCarrier to update them with label void. Requires fulfillment:write scope.

PATCH /packages/{id}

Update package dimensions / metadata

cURL

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
}
'

200

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

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

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

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

200

application/json

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

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