BAbagisto
Admin Sales: Shipments

List shipments (datagrid parity)

Paginated shipments listing mirroring the admin Sales → Shipments datagrid. Every shipment column plus the order/customer context and billing/shipping addresses is populated on each row (line items are detail-only). Returns a { data, meta } envelope. Requires sales.shipments.view permission.

get/shipments

Request

Query parameters

pageinteger
Example:1

Page number (1-based).

per_pageinteger
Example:10

Items per page (default 10, max 50).

idstring
Example:7

Filter by shipment id (integer or comma-list).

order_idstring

Partial order increment_id match.

total_qtyinteger

Exact total quantity.

inventory_source_namestring

Partial inventory source name.

shipped_tostring

Partial shipped-to name match.

order_date_fromstring date

Order created after.

order_date_tostring date

Order created before.

created_at_fromstring date

Shipment created after.

created_at_tostring date

Shipment created before.

sort'id' | 'order_id' | 'total_qty' | 'inventory_source_name' | 'shipped_to' | 'order_date' | 'created_at'

Sort column.

order'asc' | 'desc'

Sort direction.

Response

Paginated list of shipments in the { data, meta } envelope.

Changes

No recorded changes to this operation across all 8 revisions of this API.