postsale shipments
List, read, create, update, and bulk-edit shipments, and get rate quotes.
Shipment operations.
Deep docs: Shipping, labels, rates · Domain model
Subcommands
| Command | Safety | Notes |
|---|---|---|
list | read | CLI-only (not in schema --list). Order search → shipments-by-orders; pagination at order grain |
get [shipment_id] | read | Or --reference <order_id> for all shipments of an order |
| (agent-only) | write | bulk_update_insurance, bulk_update_references exist only as agent tools; no subcommand or slug |
get-rates | read | Quote only; --input / --json |
create | money-moving | --yes |
update <id> | write | |
delete <id> | destructive | --yes |
bulk-update-package | write | |
bulk-update-service | write | |
bulk-update-ship-date | write | |
bulk-update-from-address | write |
list flags
--query, --input, --json, --page, --page-size, --all, --max-items, --human
Note
Here --max-items caps the number of orders scanned, not shipment rows returned (pagination runs at order grain). On orders search, the same flag caps total items.
postsale shipments list --query "shipments processed this month"
postsale shipments get --reference <order_id>
postsale shipments get <shipment_id>
postsale shipments get-rates --input rates.json
postsale shipments create --input shipment.json --yesWith POSTSALE_TEST_LABEL_MODE set, create stamps test_label: true onto a plain shipment body and reports it in _cli_meta.applied_defaults; an explicit test_label: false and the { order, shipment } wrapper (which the backend builds from shipping rules) are refused with exit 64. update is not touched by the mode. See the safety model.
Data model
Shipment reference = parent order id. Order search does not embed shipment payloads. See data-model.
Shipments-by-order lookups are not auto-retried (possible server-side address validation write).
Schema slugs
shipments.get, shipments.get-rates, shipments.create, shipments.update, shipments.delete, bulk-update slugs. No shipments.list slug.
Agent tools
get_shipment, list_shipments_for_orders, get_rates, create_shipment, update_shipment, delete_shipment, bulk update tools, get_tracking
On this page
Related