Shipments

List all shipments in paginated result

get

Authorizations

ApiKey

AuthorizationstringRequired

Prefix the value with "ApiKey" to indicate the custom authorization type

Query parameters

trackingNumbersstring[]Required

pageinteger · int32Optional

The page number to request (1 based)

Default: 1Example: 1

sizeinteger · int32Optional

The number of results to return in a page

Default: 10Example: 10

Responses

200

OK

application/json

400

Bad request

application/json

403

Forbidden

*/*

404

Not Found

*/*

get

/api/shipments

HTTPcURLJavaScriptPython

GET /api/shipments?trackingNumbers=text HTTP/1.1
Host: apipub.firstbasehq.com
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "size": 1,
    "totalElements": 1,
    "totalPages": 1,
    "pageNumber": 1,
    "data": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "trackingCode": "1Z00000000",
        "carrier": "UPS",
        "status": "DELIVERED",
        "trackingHistory": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "status": "IN_TRANSIT",
            "createdAt": "2026-01-20T10:38:25.645Z"
          }
        ],
        "createdAt": "2026-01-20T10:38:25.645Z",
        "orderItemIds": "[123E4567-E89B-12D3-A456-426614174000, 123E4567-E89B-12D3-A456-426614175000]",
        "trackingUrl": "http://trackinglink.com/trackingcode"
      }
    ]
  }
]