Skip to main content
GET
/
client
/
shipments
List all shipments
curl --request GET \
  --url https://api.ship.uniuni.com/prod/client/shipments \
  --header 'Authorization: Bearer <token>'
{
  "message": "Shipments listed successfully",
  "code": 0,
  "data": {
    "shipments": [
      {
        "orderNumber": "UNI029834CA7",
        "trackingId": "UR07240000000004901",
        "recipient": {
          "name": "Jane Doe",
          "phone": "+1-604-123-4567",
          "email": "jane@example.com"
        },
        "address": {
          "address1": "2455 Meadowvale Blvd",
          "city": "Mississauga",
          "province": "ON",
          "postalCode": "L5N 0H1",
          "country": "CA"
        },
        "dimensions": {
          "length": 1,
          "width": 1,
          "height": 1,
          "dimensionUnit": "INCH"
        },
        "weight": {
          "value": 1,
          "weightUnit": "LB"
        },
        "status": "PENDING",
        "note": "Gift Box",
        "createdAt": "2025-07-24T23:32:09.834Z",
        "updatedAt": "2025-07-25T00:41:53.815Z",
        "rates": {
          "postageType": "NEXT DAY",
          "postageFee": 4.88,
          "tax": 0.63,
          "total": 5.51,
          "currency": "CAD"
        },
        "shipmentLineItems": [
          {
            "description": "T-shirt",
            "quantity": 1,
            "unit_value": 10,
            "currency": "CAD"
          }
        ]
      }
    ],
    "pagination": {
      "page": 1,
      "pageSize": 10,
      "count": 63
    }
  }
}

Authorizations

Authorization
string
header
required

API access token generated from the UniUni Platform dashboard.

Query Parameters

page
integer
default:1

Page number.

Required range: x >= 1
pageSize
integer
default:10

Results per page.

Required range: x <= 500
status
enum<string>

Filter by shipment status. Shipment status.

Available options:
DRAFT,
PENDING,
PICKUP_REQUESTED,
PICKUP_CANCELLED,
PARTNER_RECEIVED,
PICKED_UP,
RECEIVED,
GATEWAY_TRANSIT,
PARCEL_SCANNED,
TRANSSHIPMENT_COMPLETE,
IN_TRANSIT,
OUT_FOR_DELIVERY,
DELIVERED,
SHIPMENT_EXCEPTION,
AGED_OUT,
RETURNED,
CANCELLED,
STORAGE,
FAILED
fromDate
string<date>

Filter shipments created on or after this date (YYYY-MM-DD).

toDate
string<date>

Filter shipments created on or before this date (YYYY-MM-DD).

query
string

Search by order number or other fields.

Response

200 - application/json

Paginated list of shipments

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.