Shipment packages
AI agents: read /llms.txt; add .md to any page URL. This page as Markdown: /reference/shipment-packages.md. Index of every page and the rules for every call: /llms.txt. Guides and concepts in one file: /llms-full.txt. OpenAPI: /openapi.json.
The packages of a shipment: one per parcel of a label (a multi-parcel label makes several), with carrier, tracking number, size, weight, cost and status.
7 operations
- GETList the packages of a shipment
/Returns every package of a shipment: Shippo labels, labels recorded from elsewhere, and single labels.v2/ api/ store/ {team_slug}/ v2/ shipment/ {hash_id}/ packages - POSTFilter packages
/Returns one page of your team's packages across all sales orders (quotes, drafts and autosave copies are left out) that match the filters.v1/ api/ store/ {team_slug}/ shipment_package/ filter - GETGet a package
/Returns one package: carrier, service, tracking number, size, weight,v2/ api/ store/ {team_slug}/ v2/ shipment_package/ {hash_id} charges(in thousandths),status, whether it is the master of a multi-parcel label, and for Shippo labels the Shippo details and label file. - PATCHGet live tracking for a package
/Asks Shippo for the package's current tracking and returns Shippo's track object, unchanged, asv1/ api/ store/ {team_slug}/ shipment_package/ {id}/ track data(its fields are Shippo's: carrier, tracking number, current status and history). - PUTChange a package's status
/Sets a package's status.v2/ api/ store/ {team_slug}/ v2/ shipment_package/ {hash_id} - POSTChange and delete packages at once
/Changes the status of, or deletes, several packages of one shipment in one transaction: all of them, or none.v2/ api/ store/ {team_slug}/ v2/ shipment/ {unique_key}/ package/ bulk - DELETEDelete a package (voids its label)
/Deletes a package.v2/ api/ store/ {team_slug}/ v2/ shipment_package/ {hash_id}