List Shipments (Datagrid)

Mirrors the admin Sales → Shipments datagrid. Every shipment column plus the order/customer context and both the billing and shipping addresses are populated on each row — the field set is identical to Shipment Detail except for the shipped line items, which are returned only by the detail endpoint ([] on the listing).

How this menu works

For when a shipment row appears and what each field means, see the Shipments overview.

Endpoint

Endpoint	Method
/api/admin/shipments	GET

Query Parameters

Parameter	Type	Description
page, per_page	integer	Pagination (default per_page=10, cap 50).
id	string	Filter by shipment id (int or comma-list).
order_id	string	Partial match on orders.increment_id.
total_qty	integer	Exact total quantity.
inventory_source_name	string	Partial source name.
shipped_to	string	Partial shipped-to (address full-name).
order_date_from / order_date_to	date	Order created range.
created_at_from / created_at_to	date	Shipment created range.
sort	string	id, order_id, total_qty, inventory_source_name, shipped_to, order_date, created_at.
order	string	asc, desc.

Permission

sales.shipments.view