Shipments
AI agents: read /llms.txt; add .md to any page URL. This page as Markdown: /reference/shipments.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.
Shipments send some or all of an order's lines to one address by one shipping type, with packages, labels and documents.
Learn more: Shipping · Ship an order
13 operations
- POSTCreate a shipment for a sales order
/Creates an empty shipment for an order: one address, one shipping type.v2/ api/ store/ {team_slug}/ v2/ sales_order/ {unique_key}/ shipment - GETList the shipments of a sales order
/Returns the shipments of an order with their lines, estimates and packages.v2/ api/ store/ {team_slug}/ v2/ sales_order/ {unique_key}/ shipment - POSTFilter shipments
/Returns one page of your team's shipments that match the filters, across all sales orders (quotes, drafts and deleted shipments are left out).v1/ api/ store/ {team_slug}/ shipment/ filter - PATCHCheck a shipment's address with the carrier
/Checks the shipment's shipping address with UPS address validation, for supported countries, and saves the result on the address.v2/ api/ store/ {team_slug}/ v2/ sales_order/ {hash_id}/ shipment/ {id}/ validate_address - GETGet a shipment
/A shipment sends some or all of a sales order's (or quote's) lines to one address, by one shipping type.v2/ api/ store/ {team_slug}/ v2/ shipment/ {unique_key} - PUTAssign or unassign a team member on a shipment
/Adds a team member to a shipment's assignees withv2/ api/ store/ {team_slug}/ v2/ sales_order/ {hash_id}/ shipment/ {id}/ assign action: "assign", or removes them withaction: "unassign". - PUTChange the status of a shipment
/Moves a shipment to another shipment status.v2/ api/ store/ {team_slug}/ v2/ sales_order/ {hash_id}/ shipment/ {id}/ status - PUTUpdate a shipment
/Changes a shipment's number, shipping type, address, receiver contact, brand profile, packer and notes.v2/ api/ store/ {team_slug}/ v2/ shipment/ {unique_key} - DELETEDelete a shipment
/Deletes a shipment with its lines, packages and shipping estimates.v2/ api/ store/ {team_slug}/ v2/ shipment/ {unique_key} - POSTDownload shipments as CSV
/Returns a CSV file (v1/ api/ store/ {team_slug}/ shipment/ action/ export_csv shipment_export_<time>.csv) with one row per shipment: order number, shipment number (SHIP-...), shipping type, customer name, email and contact, and the full shipping address. - POSTDownload 4x6 shipment labels (PDF)
/Returns one PDF of 4" x 6" shipment labels (ship-from and ship-to addresses and a barcode), one per shipment, made while you wait.v1/ api/ store/ {team_slug}/ shipment/ export_label - POSTDownload letter-size shipment labels (PDF)
/Returns one PDF of letter-size shipment labels, one per shipment, made while you wait.v1/ api/ store/ {team_slug}/ shipment/ export_label_full - POSTDownload packing slips (PDF)
/Returns one PDF with a packing slip per shipment, made while you wait.v1/ api/ store/ {team_slug}/ shipment/ export_packing_slip
Legacy and internal (1)
Prefer the operations above. Legacy operations name their replacement; internal ones are built for YoPrint's own apps.
- PATCHDelete all shipments of an order (retired)Legacy · deprecated
/Retired: this operation does nothing and always answers with the error codev2/ api/ store/ {team_slug}/ v2/ sales_order/ {hash_id}/ shipment/ delete_all depcreated(HTTP 500).