API ReferencePickupsGet a pickup

Get a pickup

GET/api/v1/pickups/{pickup_id}

One pickup. pickup_id is the id returned by the booking or the list. Another account's pickup, a pickup of the other mode (test/live) and an unknown id all answer the same 404. Requires scope pickups:read.

Parameters

pickup_id*

stringpath

Responses

Success body

{
  "status": 200,
  "message": "OK",
  "data": {
    "id": "6710a1b2c3d4e5f607182960",
    "livemode": false,
    "simulated": true,
    "manifest_id": null,
    "address_group_id": "6710a1b2c3d4e5f607182951",
    "status": "requested",
    "destination": "yunexpress",
    "parcel_carriers": [
      "yunexpress"
    ],
    "shipment_ids": [
      "6710a1b2c3d4e5f607182931"
    ],
    "tracking_numbers": [
      "IM2610190000000001"
    ],
    "pickup_date": "2026-10-21",
    "scheduled_pickup_date": "2026-10-21",
    "pickup_window": {
      "start": "13:00",
      "end": "17:00",
      "timezone": "Asia/Hong_Kong"
    },
    "pickup_address": {
      "name": "Chan Tai Man",
      "phone": "+852 91234567",
      "email": "ops@example.com",
      "address_line": "Unit 1203, 12/F, Tower 2, Kowloon Commerce Centre, 51 Kwai Cheong Road, Kwai Chung"
    },
    "carrier_tracking_number": null,
    "pickup_courier": null,
    "failure_reason": null,
    "fee": {
      "scope": "address_group",
      "state": "provisional",
      "estimated_hkd": 45,
      "charged_hkd": 0,
      "refunded_hkd": 0
    },
    "cancellation": {
      "allowed": true,
      "deadline": "2026-10-19T04:12:40.123Z",
      "reason_code": null
    },
    "created_at": "2026-10-19T03:12:40.123Z",
    "updated_at": "2026-10-19T03:12:40.123Z"
  }
}

Returned object

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

{ "status": 200, "message": "OK", "data": { "id": "6710a1b2c3d4e5f607182960", "livemode": false, "simulated": true, "manifest_id": null, "address_group_id": "6710a1b2c3d4e5f607182951", "status": "requested", "destination": "yunexpress", "parcel_carriers": [ "yunexpress" ], "shipment_ids": [ "6710a1b2c3d4e5f607182931" ], "tracking_numbers": [ "IM2610190000000001" ], "pickup_date": "2026-10-21", "scheduled_pickup_date": "2026-10-21", "pickup_window": { "start": "13:00", "end": "17:00", "timezone": "Asia/Hong_Kong" }, "pickup_address": { "name": "Chan Tai Man", "phone": "+852 91234567", "email": "ops@example.com", "address_line": "Unit 1203, 12/F, Tower 2, Kowloon Commerce Centre, 51 Kwai Cheong Road, Kwai Chung" }, "carrier_tracking_number": null, "pickup_courier": null, "failure_reason": null, "fee": { "scope": "address_group", "state": "provisional", "estimated_hkd": 45, "charged_hkd": 0, "refunded_hkd": 0 }, "cancellation": { "allowed": true, "deadline": "2026-10-19T04:12:40.123Z", "reason_code": null }, "created_at": "2026-10-19T03:12:40.123Z", "updated_at": "2026-10-19T03:12:40.123Z" } }