---
title: "List all batches"
method: GET
path: "/client/batch"
tags: ["Batches"]
---

# List all batches

`GET /client/batch`

Retrieves a paginated list of batches.

## Query parameters

- `page` integer
- `pageSize` integer
- `isNotInPickup` boolean

## Response `200`

Paginated list of batches

- object
  - `message` string, required — Additional information about the request status.
  - `code` integer, required — Status code. 0 indicates success.
  - `data` ListBatchesResponseData
    - `batches` Batch[], required
      - `batchNumber` string — Unique batch identifier.
      - `batchName` string — Batch name.
      - `status` 'PENDING' | 'PICKUP_REQUESTED' | 'PICKUP_CANCELLED' | 'PARTNER_RECEIVED' | 'PICKED_UP' | 'RECEIVED' — Batch status.
      - `printedLabel` boolean — Whether the batch label has been printed.
      - `createdAt` string, date-time
      - `updatedAt` string, date-time
      - `shipmentCount` integer — Number of shipments in the batch.
      - `shipments` string[] — List of shipment order numbers.
    - `pagination` Pagination, required
      - `page` integer
      - `pageSize` integer
      - `count` integer — Total number of records.

---

[API](https://skmtc.dev/uniuni/apis/uniuni-platform-client-api.md) · [All operations](https://skmtc.dev/uniuni/apis/uniuni-platform-client-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/uniuni/uniuni-platform-client-api/revisions/d61334c7f8b1/schema)