API ReferencePickupsList self drop-offs

List self drop-offs

GET/api/v1/pickups/self-dropoffs

The account's self drop-off records, newest first, including the declarations made in the web portal. Keyset pagination. One record belongs to one destination warehouse: a declaration whose shipments go to several warehouses produces several records. shipment_ids are the selection ids of GET /v1/pickups/eligible-shipments, not the shipment ids of /v1/shipments. updated_after is an RFC 3339 date-time with a timezone. A test key lists only test records and a live key only live ones. Requires scope pickups:read. Listing needs only the pickup API master switch.

Parameters

limit

integerquery

cursor

stringquery

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

status

stringquery

dropoff_date

stringquery

A real calendar date, YYYY-MM-DD (Hong Kong).

updated_after

stringquery

RFC 3339 date-time with a timezone (Z or ±hh:mm), e.g. 2026-10-19T00:00:00Z. Anything else is a 400.

Responses

Success body

{
  "status": 200,
  "message": "OK",
  "data": {
    "data": [
      {
        "self_dropoff_id": "6710a1b2c3d4e5f607182972",
        "status": "declared",
        "shipment_ids": [
          "6710a1b2c3d4e5f607182933"
        ],
        "dropoff_date": "2026-10-30",
        "destination_mode": "per_carrier",
        "warehouse_key": "globavend",
        "warehouse": {
          "code": null,
          "name": "Globavend Hong Kong warehouse",
          "mobile_prefix": "+852",
          "mobile": "55550200",
          "address": "Unit 5, 9/F, 33 Sample Street, Tsuen Wan, New Territories, Hong Kong"
        },
        "customer_tracking_number": "MY-GV-0001",
        "remark": "Dropped off by our courier in the afternoon",
        "created_at": "2026-10-28T03:12:40.123Z",
        "updated_at": "2026-10-28T03:12:40.123Z",
        "arrived_at": null,
        "cancelled_at": null,
        "livemode": false,
        "simulated": true
      },
      {
        "self_dropoff_id": "6710a1b2c3d4e5f607182971",
        "status": "declared",
        "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-28T03:12:40.123Z",
        "arrived_at": null,
        "cancelled_at": null,
        "livemode": false,
        "simulated": true
      }
    ],
    "next_cursor": null
  }
}

Returned object

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