Skip to main content
GET
/
client
/
batch
/
{batchNumber}
Retrieve a batch
curl --request GET \
  --url https://api.ship.uniuni.com/prod/client/batch/{batchNumber} \
  --header 'Authorization: Bearer <token>'
{
  "message": "Success",
  "code": 0,
  "data": {
    "batchNumber": "URB0714000000000687",
    "batchName": "Test batch 1 7-14-2025",
    "status": "RECEIVED",
    "printedLabel": false,
    "createdAt": "2025-07-14T17:59:27.645Z",
    "updatedAt": "2025-07-14T18:53:57.669Z",
    "shipmentCount": 1,
    "shipments": [
      "UNI07787536D"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

API access token generated from the UniUni Platform dashboard.

Path Parameters

​
batchNumber
string
required

The unique batch number (e.g. URB0714000000000687).

Response

200 - application/json

Batch details or error

​
message
string
required

Additional information about the request status.

​
code
integer
required

Status code. 0 indicates success.

​
data
any

Response payload. Returns null if code is not 0.