API ReferencePickupsList shipments that can be picked up

List shipments that can be picked up

GET/api/v1/pickups/eligible-shipments

Shipments that can be arranged for pickup right now, newest first. Uses the same eligibility as the booking, so a listed shipment can be booked. shipment_id here is the pickup-selection id to send in shipment_ids; it is not the shipment id of /v1/shipments, which is the tracking_number returned next to it. Requires scope pickups:read.

Parameters

limit

integerquery

cursor

stringquery

Opaque cursor from a previous response's next_cursor field. Only valid with the same filters.

Responses

Success body

{
  "status": 200,
  "message": "OK",
  "data": {
    "data": [
      {
        "shipment_id": "6710a1b2c3d4e5f607182931",
        "tracking_number": "IM2610190000000001",
        "reference_no": "PO-2026-1019-0003",
        "carrier": "yunexpress",
        "destination": "yunexpress",
        "recipient_country": "US",
        "created_at": "2026-10-19T02:58:11.402Z",
        "livemode": false
      }
    ],
    "next_cursor": null
  }
}

Returned object

Field	Type	Sample
status	number	200
message	string	OK
data	object	{2 keys}