Skip to main content
GET
/
v1
/
shipments
List shipments
curl --request GET \
  --url https://sandbox-api.easecustoms.com/v1/shipments \
  --header 'Authorization: Bearer <token>'
{
  "page": 1,
  "itemsPerPage": 20,
  "itemCount": 56,
  "result": [
    {
      "shipmentId": 99,
      "referenceNumber": "180-43189021",
      "status": "clearanceInProgress",
      "createdAt": "2026-06-10T08:30:00.000Z",
      "updatedAt": "2026-06-10T08:31:00.000Z"
    }
  ]
}
Returns a paginated list of shipments. Filter by status or reference numbers.

Query Parameters

page
integer
default:"1"
Page number (1-indexed).
limit
integer
default:"20"
Items per page (max 100).
status
string
Filter by shipment status. Allowed values: new, clearanceInProgress, completed.
referenceNumber
string
Filter by shipment reference number.
dateFrom
string
Created on or after (YYYY-MM-DD).
dateTo
string
Created on or before (YYYY-MM-DD).
sortOrder
string
default:"desc"
Sort order (asc or desc).
{
  "page": 1,
  "itemsPerPage": 20,
  "itemCount": 56,
  "result": [
    {
      "shipmentId": 99,
      "referenceNumber": "180-43189021",
      "status": "clearanceInProgress",
      "createdAt": "2026-06-10T08:30:00.000Z",
      "updatedAt": "2026-06-10T08:31:00.000Z"
    }
  ]
}