Skip to main content
GET
/
pickups
/
{id}
Retrieve a pickup
curl --request GET \
  --url https://panel.sendcloud.sc/api/v3/pickups/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": {
    "id": 1,
    "address": {
      "name": "John Doe",
      "city": "Eindhoven",
      "country_code": "NL",
      "address_line_1": "Stadhuisplein",
      "house_number": "10",
      "address_line_2": "",
      "postal_code": "5611 EM",
      "company_name": "Sendcloud",
      "email": "example@sendcloud.com",
      "phone_number": "+310612345678"
    },
    "time_slots": [
      {
        "start_at": "2022-04-06T12:00:00Z",
        "end_at": "2022-04-06T17:00:00Z"
      }
    ],
    "items": [
      {
        "quantity": 20,
        "container_type": "parcel",
        "total_weight": {
          "value": "1.00",
          "unit": "kg"
        }
      }
    ],
    "reference": "",
    "special_instructions": "",
    "tracking_number": "PRG220406002044",
    "status": "CANCELLED",
    "created_at": "2022-03-30T09:20:37.957495Z",
    "cancelled_at": "2022-03-30T09:20:45.433367Z",
    "carrier_code": "dhl_express",
    "contract_id": 10
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
integer
required

The id of the pickup you want to retrieve.

Response

OK

​
data
BRT Pickup Object · object