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"
}Pickups API
Create a pickup
Schedule a pickup with a carrier (note that the carrier must support pickups).
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"
}OAuth2 scopes required:
write:pickup. See Scopes for OAuth apps.API v2 is entering maintenance mode. New users should start with API v3 to access our latest features and improved performance. Already using v2? Don’t worry, your current integration remains fully functional. Read more about maintenance mode, or check out the migration guide for API v3.
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
HTTPBasicAuthOAuth2ClientCreds
Body
application/json
- Pickup request
- FedEx Pickup request
- Correos Express Pickup request
- DHL Pickup request
- DPD Pickup request
- Poste Italiane Delivery Pickup request
- Correos Express Pickup request
- UPS Pickup request
- DHL Parcel Iberia 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.
- DHL Express Pickup Object
- FedEx Pickup Object
- Correos Express Pickup Object
- DHL Pickup Object
- DPD Pickup Object
- Poste Italiane Delivery Pickup Object
- Correos Pickup Object
- UPS Pickup Object
- DHL Parcel Iberia Pickup Object
A Sendcloud pickup object