---
title: "Create a batch"
method: POST
path: "/client/batch/create"
tags: ["Batches"]
---

# Create a batch

`POST /client/batch/create`

Creates a new batch. You can optionally include purchased shipments at creation time, or create an empty batch and add shipments later.

## Request body

- CreateBatchRequest
  - `batchName` string — Name for the batch.
  - `shipments` string[] — List of order numbers to include. Only purchased shipments can be added.

## Response `200`

Batch created or error

- object
  - `message` string, required — Additional information about the request status.
  - `code` integer, required — Status code. 0 indicates success.
  - `data` Batch
    - `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.

---

[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)