# Shipments

Section: Shipping. Part of the [API reference](https://developer.yoprint.com/reference.md). Web page: https://developer.yoprint.com/reference/shipments/

This page and all 14 operation pages, in 3 files: https://developer.yoprint.com/llms/shipments.txt (operations 1 to 4), https://developer.yoprint.com/llms/shipments-2.txt (operations 5 to 9), https://developer.yoprint.com/llms/shipments-3.txt (operations 10 to 14)

Shipments send some or all of an order's lines to one address by one shipping type, with packages, labels and documents.

## Operations (13)

- [Create a shipment for a sales order](https://developer.yoprint.com/reference/shipments/v2-sales-order-shipment-create.md): `POST /v2/api/store/{team_slug}/v2/sales_order/{unique_key}/shipment`. Creates an empty shipment for an order: one address, one shipping type.
- [List the shipments of a sales order](https://developer.yoprint.com/reference/shipments/v2-sales-order-shipment-index-for-order.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{unique_key}/shipment`. Returns the shipments of an order with their lines, estimates and packages.
- [Filter shipments](https://developer.yoprint.com/reference/shipments/v1-shipment-filter.md): `POST /v1/api/store/{team_slug}/shipment/filter`. Returns one page of your team's shipments that match the filters, across all sales orders (quotes, drafts and deleted shipments are left out).
- [Check a shipment's address with the carrier](https://developer.yoprint.com/reference/shipments/v2-sales-order-shipment-validate-address.md): `PATCH /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/shipment/{id}/validate_address`. Checks the shipment's shipping address with UPS address validation, for supported countries, and saves the result on the address.
- [Get a shipment](https://developer.yoprint.com/reference/shipments/v2-shipment-show.md): `GET /v2/api/store/{team_slug}/v2/shipment/{unique_key}`. A shipment sends some or all of a sales order's (or quote's) lines to one address, by one shipping type.
- [Assign or unassign a team member on a shipment](https://developer.yoprint.com/reference/shipments/v2-sales-order-shipment-assign.md): `PUT /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/shipment/{id}/assign`. Adds a team member to a shipment's assignees with `action: "assign"`, or removes them with `action: "unassign"`.
- [Change the status of a shipment](https://developer.yoprint.com/reference/shipments/v2-sales-order-shipment-change-status.md): `PUT /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/shipment/{id}/status`. Moves a shipment to another shipment status.
- [Update a shipment](https://developer.yoprint.com/reference/shipments/v2-shipment-update.md): `PUT /v2/api/store/{team_slug}/v2/shipment/{unique_key}`. Changes a shipment's number, shipping type, address, receiver contact, brand profile, packer and notes.
- [Delete a shipment](https://developer.yoprint.com/reference/shipments/v2-shipment-destroy.md): `DELETE /v2/api/store/{team_slug}/v2/shipment/{unique_key}`. Deletes a shipment with its lines, packages and shipping estimates.
- [Download shipments as CSV](https://developer.yoprint.com/reference/shipments/v1-shipment-export-csv.md): `POST /v1/api/store/{team_slug}/shipment/action/export_csv`. Returns a CSV file (`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.
- [Download 4x6 shipment labels (PDF)](https://developer.yoprint.com/reference/shipments/v1-shipment-export-label.md): `POST /v1/api/store/{team_slug}/shipment/export_label`. 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.
- [Download letter-size shipment labels (PDF)](https://developer.yoprint.com/reference/shipments/v1-shipment-export-label-full.md): `POST /v1/api/store/{team_slug}/shipment/export_label_full`. Returns one PDF of letter-size shipment labels, one per shipment, made while you wait.
- [Download packing slips (PDF)](https://developer.yoprint.com/reference/shipments/v1-shipment-export-packing-slip.md): `POST /v1/api/store/{team_slug}/shipment/export_packing_slip`. Returns one PDF with a packing slip per shipment, made while you wait.

## Legacy and internal operations (1)

Prefer the operations above. Legacy ones name their replacement; internal ones are built for YoPrint's own apps.

- [Delete all shipments of an order (retired)](https://developer.yoprint.com/reference/shipments/v2-sales-order-shipment-destroy-all.md): `PATCH /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/shipment/delete_all` (legacy, deprecated). Retired: this operation does nothing and always answers with the error code `depcreated` (HTTP 500).