Skip to main content
GET
/
pickups
Retrieve a list of pickups
curl --request GET \
  --url https://panel.sendcloud.sc/api/v3/pickups \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": [
    {
      "id": 1,
      "time_slots": [
        {
          "start_at": "2022-04-06T12:00:00Z",
          "end_at": "2022-04-06T17:00:00Z"
        }
      ],
      "country": "NL",
      "carrier_code": "dhl_express",
      "tracking_number": "PRG220406003404",
      "status": "CANCELLED",
      "created_at": "2022-03-30T10:57:02.344479Z",
      "cancelled_at": "2022-03-30T10:57:11.656260Z"
    },
    {
      "id": 2,
      "time_slots": [
        {
          "start_at": "2022-04-06T12:00:00Z",
          "end_at": "2022-04-06T17:00:00Z"
        }
      ],
      "country": "NL",
      "carrier_code": "dhl_express",
      "tracking_number": "PRG220406002044",
      "status": "CANCELLED",
      "created_at": "2022-03-30T09:20:37.957495Z",
      "cancelled_at": "2022-03-30T09:20:45.433367Z",
      "contract_id": 10
    }
  ]
}
This is limited to the carriers which support pickups via the API. The response includes information about when the pickup was scheduled, the latest status, the parcel tracking number and the time frame in which the pickup is due to take place.

Authorizations

​
Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Query Parameters

​
page_size
integer

Amount of pickups that will be shown per page.

Required range: 1 <= x <= 100
Example:

10

Response

200 - application/json

OK

​
data
Pickup Object (List Item) · object[]