Override the carrier and service for this package
Changes the carrier and service level for a package. If a label has already been purchased,
the existing label is voided before the carrier is updated. A new label must be purchased
after changing the carrier.
Requires fulfillment:write scope.
Authorizations
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
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.
255Path Parameters
Response
Package with updated carrier and service
A shipment / box created during fulfillment. One package contains many package items (line item splits) and at most one shipment label.
package Sequential per entity.
packing, packed, labeled, shipped, delivered, returned, void e.g. ups, usps, fedex, dhl.
e.g. ground, priority, 2day.
Cost billed to customer (vs purchased cost).
Manual override of the auto-computed Shippo-insurance declared value. When set, overrides the value derived from products flagged apply_freight_insurance.
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.

