Skip to main content
POST
/
pickups
curl --request POST \
  --url https://panel.sendcloud.sc/api/v2/pickups \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "city": "Eindhoven",
  "company_name": "Sendcloud",
  "name": "John Doe",
  "country": "NL",
  "email": "example@sendcloud.com",
  "address": "Stadhuisplein 10",
  "address_2": "",
  "pickup_from": "2022-04-06T12:00:00Z",
  "pickup_until": "2022-04-06T17:00:00Z",
  "postal_code": "5611 EM",
  "quantity": 20,
  "telephone": "0612345678",
  "total_weight": "1",
  "carrier": "dhl_express"
}
'
{
  "id": 294247,
  "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": "",
  "pickup_status": "Announcing",
  "created_at": "2022-03-30T09:20:37.957495Z",
  "cancelled_at": null,
  "carrier": "dhl_express"
}
See a list of carriers which support pickups. You can schedule the pickup to take place from a location and time of your choosing, and include any additional instructions to the driver by including the special_instructions parameter. When a pickup is successfully scheduled a pickup id will be returned.
If you have more than one active contract for a specific carrier, you must send the contract field with your desired contract ID in your request. You can get your contract ID from the Retrieve a list of contracts endpoint.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
city
string
required
Minimum string length: 1
​
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"

​
address
string
required

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

Minimum string length: 1
​
pickup_from
string<date-time>
required

ISO 8601 DateTime that indicates from what time the pickup can take place. Preferably specified in UTC. When no timezone information is specified, we will use the timezone of the user their invoice address country.

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.

​
name
string | null

Contact person name.

Minimum string length: 1
​
country_state
string | null
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 | null

Address line 2 of the pickup.

​
pickup_until
string<date-time> | null

ISO 8601 DateTime that indicates until what time the pickup can take place. Preferably specified in UTC. When no timezone information is specified, we will use the timezone of the user their invoice address country.

Minimum string length: 1
​
telephone
string | null

Contact person telephone number.

​
reference
string | null

A reference number for your own administration.

​
special_instructions
string | null

Special instructions that the driver should take into account.

Minimum string length: 1
​
carrier
string

The user selected carrier code for the pickup.

Example:

"dhl_express"

​
contract
integer | null

Id of the contract you want to be used for pickup request.

Response

Created - This means that the data is send to the carrier successfully, to see if the carrier accepted the pickup request check the status of the pickup via the GET endpoint.

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.