Skip to main content
GET
/
pickups
/
{id}
Retrieve a pickup
curl --request GET \
  --url https://panel.sendcloud.sc/api/v2/pickups/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": 1,
  "city": "Eindhoven",
  "country": "NL",
  "address": "Stadhuisplein 10",
  "pickup_from": "2022-04-06T12:00:00Z",
  "postal_code": "5611 EM",
  "quantity": 20,
  "company_name": "Sendcloud",
  "name": "John Doe",
  "email": "example@sendcloud.com",
  "address_2": "",
  "pickup_until": "2022-04-06T17:00:00Z",
  "reference": "",
  "special_instructions": "",
  "telephone": "0612345678",
  "total_weight": "1.00",
  "tracking_number": "PRG220406002044",
  "pickup_status": "Cancelled",
  "created_at": "2022-03-30T09:20:37.957495Z",
  "cancelled_at": "2022-03-30T09:20:45.433367Z",
  "carrier": "dhl_express"
}

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

A Sendcloud pickup object

​
id
integer<int64>
required

Unique identifier of the pickup.

Required range: x >= 1
​
carrier
string
required

The user selected carrier code for the pickup.

Example:

"dhl_express"

​
country
enum<string>
required

ISO 3166-1 alpha-2 country code.

Available options:
NL,
DE,
ES,
FR,
IT,
AT
Required string length: 2
Example:

"NL"

​
city
string
required
Minimum string length: 1
​
address
string
required

Address line 1 of the pickup, this should include the house number.

Minimum string length: 1
​
postal_code
string
required
Minimum string length: 1
​
quantity
integer<int64>
required

Number of parcels that should be picked up.

Required range: x >= 1
​
total_weight
string | null
required

Total weight in kilograms.

​
pickup_from
string<date-time>
required

ISO 8601 DateTime when the pickup should take place.

Minimum string length: 1
​
pickup_status
enum<string>
required
Available options:
Created,
Cancelled,
Failed,
Announcing
​
created_at
string<date-time>
required

ISO 8601 DateTime at which the pickup is created.

Minimum string length: 1
​
cancelled_at
string<date-time> | null
required

ISO 8601 DateTime at which the pickup is cancelled.

Minimum string length: 1
​
name
string | null

Contact person name.

Minimum string length: 1
​
country_state
string | null

A country state (if applicable).

Minimum string length: 1
​
company_name
string | null

Pickup address company name.

Minimum string length: 1
​
email
string<email> | null

Contact person email.

Minimum string length: 1
​
address_2
string

Address line 2 of the pickup.

​
telephone
string | null

Contact person telephone number.

​
reference
string

A reference number for your own administration.

​
special_instructions
string

Special instructions that the driver should take into account.

​
tracking_number
string | null
​
pickup_until
string<date-time> | null

ISO 8601 DateTime of the pickup location close time. This could be useful in case the pickup is delayed.

Minimum string length: 1
​
contract
integer

Id of the contract that is used to create the pickup.