---
title: "List shipments (datagrid parity)"
method: GET
path: "/shipments"
tags: ["Admin Sales: Shipments"]
---

# List shipments (datagrid parity)

`GET /shipments`

## Request

- Base URL: `http://localhost:8000/api/admin`
- URL: `http://localhost:8000/api/admin/shipments`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/bagisto/apis/bagisto-admin-api/docs/shipments/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Query parameters

- `page` integer
- `per_page` integer
- `id` string
- `order_id` string
- `total_qty` integer
- `inventory_source_name` string
- `shipped_to` string
- `order_date_from` string, date
- `order_date_to` string, date
- `created_at_from` string, date
- `created_at_to` string, date
- `sort` 'id' | 'order_id' | 'total_qty' | 'inventory_source_name' | 'shipped_to' | 'order_date' | 'created_at'
- `order` 'asc' | 'desc'

## Response `200`

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

---

[API](https://skmtc.dev/bagisto/apis/bagisto-admin-api.md) - [All operations](https://skmtc.dev/bagisto/apis/bagisto-admin-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bagisto/apis/bagisto-admin-api/revisions/3198f11be70f?raw)