API ReferencePickupsGet a self drop-off

Get a self drop-off

GET/api/v1/pickups/self-dropoffs/{self_dropoff_id}

One self drop-off record. self_dropoff_id is the self_dropoff_id returned by the declaration or the list. Another account's record, a record of the other mode (test/live) and an unknown id all answer the same 404. There is no cancel, update or delete endpoint for a self drop-off. Always the latest state; the webhook events are only a notification. Requires scope pickups:read.

Parameters

self_dropoff_id*

stringpath

Responses

Success body

{
  "status": 200,
  "message": "OK",
  "data": {
    "self_dropoff_id": "6710a1b2c3d4e5f607182971",
    "status": "arrived_at_warehouse",
    "shipment_ids": [
      "6710a1b2c3d4e5f607182932"
    ],
    "dropoff_date": "2026-10-30",
    "destination_mode": "per_carrier",
    "warehouse_key": "yunexpress",
    "warehouse": {
      "code": null,
      "name": "YunExpress Hong Kong warehouse",
      "mobile_prefix": "+852",
      "mobile": "55550100",
      "address": "Warehouse 3, 18 Example Road, Kwai Chung, New Territories, Hong Kong"
    },
    "customer_tracking_number": null,
    "remark": "Dropped off by our courier in the afternoon",
    "created_at": "2026-10-28T03:12:40.123Z",
    "updated_at": "2026-10-30T06:41:12.000Z",
    "arrived_at": "2026-10-30T06:41:12.000Z",
    "cancelled_at": null,
    "livemode": false,
    "simulated": true
  }
}

Returned object

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

{ "status": 200, "message": "OK", "data": { "self_dropoff_id": "6710a1b2c3d4e5f607182971", "status": "arrived_at_warehouse", "shipment_ids": [ "6710a1b2c3d4e5f607182932" ], "dropoff_date": "2026-10-30", "destination_mode": "per_carrier", "warehouse_key": "yunexpress", "warehouse": { "code": null, "name": "YunExpress Hong Kong warehouse", "mobile_prefix": "+852", "mobile": "55550100", "address": "Warehouse 3, 18 Example Road, Kwai Chung, New Territories, Hong Kong" }, "customer_tracking_number": null, "remark": "Dropped off by our courier in the afternoon", "created_at": "2026-10-28T03:12:40.123Z", "updated_at": "2026-10-30T06:41:12.000Z", "arrived_at": "2026-10-30T06:41:12.000Z", "cancelled_at": null, "livemode": false, "simulated": true } }