Skip to main content
POST
/
client
/
batch
/
{batchNumber}
/
addShipment
Add shipments to a batch
curl --request POST \
  --url https://api.ship.uniuni.com/prod/client/batch/{batchNumber}/addShipment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "shipments": [
    "UNI02947917E",
    "UNI0114576F0"
  ]
}
'
{
  "message": "Shipments added to batch successfully",
  "code": 0,
  "data": {
    "batchNumber": "URB0714000000000727",
    "batchName": "test",
    "status": "PENDING",
    "printedLabel": false,
    "shipmentCount": 2
  }
}
Each shipment can only belong to one batch. If a shipment is already in another batch, it will be moved to this one.

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

Body

application/json
​
shipments
string[]
required

List of order numbers.

Response

200 - application/json

Shipments added 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.