Get self drop-off configuration

What to know before you declare a self drop-off: allowed_dates_by_warehouse_key (the dates you may use, per destination warehouse), warehouses (where to take the parcels, per destination warehouse), destination_mode (how your account's parcels are split; blocked means a declaration cannot be made right now, blocked_reason says why), max_shipments (the cap per declaration) and the timezone. The configuration is the same for live and test keys. The declaration reads and checks all of it again when you submit, so a date that was allowed here can still be refused later. Requires scope pickups:read. Until the self drop-off API is switched on for your environment the config and declaration endpoints answer 503 PICKUP_FEATURE_DISABLED (1500103) with data.reason_code public_api_self_dropoff_disabled; with a live key a declaration also needs the web self drop-off feature (reason self_dropoff_disabled). Listing and reading records only need the pickup API master switch (reason public_api_pickups_disabled).

Parameters

No parameters.

Responses

{
  "status": 200,
  "message": "OK",
  "data": {
    "allowed_dates_by_warehouse_key": {
      "yunexpress": [
        "2026-10-29",
        "2026-10-30",
        "2026-11-02"
      ],
      "globavend": [
        "2026-10-30",
        "2026-11-02"
      ],
      "imile": []
    },
    "max_shipments": 300,
    "warehouses": {
      "yunexpress": {
        "code": null,
        "name": "YunExpress Hong Kong warehouse",
        "mobile_prefix": "+852",
        "mobile": "55550100",
        "address": "Warehouse 3, 18 Example Road, Kwai Chung, New Territories, Hong Kong"
      },
      "globavend": {
        "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"
      },
      "imile": null
    },
    "destination_mode": {
      "mode": "per_carrier"
    },
    "timezone": "Asia/Hong_Kong"
  }
}

Returned object