Skip to main content

List Inbound Shipments

GET 
/api/inbound-shipments

Returns a paginated list of inbound shipments. Supports Spatie QueryBuilder filters and sorts.

Authentication: Requires Bearer token.

Available sorts: id, shipment_number, status, carrier, tracking_number, expected_arrival_date, actual_arrival_date, shipped_at, num_lines, created_at, updated_at

Default sort: -id (newest first)

Pagination defaults: 10 per page

Logistics tracking date filter columns: logistics_<slug>estimate, logistics<slug>_actual — where <slug> is the slug of any active LogisticsTrackingField. Each shipment row also includes a logistics_tracking_field_values array with { field_slug, field_name, estimate_date, actual_date } entries for every active logistics tracking field.

Each shipment row also includes a purchase_orders array — the distinct set of purchase orders linked via the shipment’s lines, each as { id, purchase_order_number }. A single linked PO yields a one-element array; multiple yields N entries.

Request​

Responses​

Successful response