Skip to main content
POST
Unpack a packed-but-unshipped order

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
reason
string

Operator-supplied reason; defaults to 'unpack_and_edit'.

Response

Order unpacked. Response surfaces the package_ids_cancelled[] and label_voids[] arrays so the caller can confirm the carrier-side void outcome. label_void_errors[] (optional) lists labels that failed to void at Shippo (non-fatal -- the operator can retry the void from the shipping routes or hand-void in the Shippo dashboard).

data
object