Cancel a pickup
curl --request POST \
--url https://panel.sendcloud.sc/api/v3/pickups/{id}/cancel \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://panel.sendcloud.sc/api/v3/pickups/{id}/cancel"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://panel.sendcloud.sc/api/v3/pickups/{id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://panel.sendcloud.sc/api/v3/pickups/{id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://panel.sendcloud.sc/api/v3/pickups/{id}/cancel"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://panel.sendcloud.sc/api/v3/pickups/{id}/cancel")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://panel.sendcloud.sc/api/v3/pickups/{id}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"data": {
"id": 1,
"time_slots": [
{
"start_at": "2022-04-06T12:00:00Z",
"end_at": "2022-04-06T17:00:00Z"
}
],
"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"
},
"items": [
{
"quantity": 1,
"container_type": "parcel",
"total_weight": {
"value": "2.00",
"unit": "kg"
}
}
],
"reference": "",
"special_instructions": "",
"tracking_number": "PRG220406003404",
"status": "CANCELLED",
"created_at": "2022-03-30T10:57:02.344479Z",
"cancelled_at": "2022-03-30T10:57:11.656260Z",
"carrier_code": "dhl_express",
"contract_id": 10
}
}Pickups
Cancel a pickup
Cancel a scheduled pickup, if the carrier and the pickup allow it.
POST
/
pickups
/
{id}
/
cancel
Cancel a pickup
curl --request POST \
--url https://panel.sendcloud.sc/api/v3/pickups/{id}/cancel \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://panel.sendcloud.sc/api/v3/pickups/{id}/cancel"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://panel.sendcloud.sc/api/v3/pickups/{id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://panel.sendcloud.sc/api/v3/pickups/{id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://panel.sendcloud.sc/api/v3/pickups/{id}/cancel"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://panel.sendcloud.sc/api/v3/pickups/{id}/cancel")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://panel.sendcloud.sc/api/v3/pickups/{id}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"data": {
"id": 1,
"time_slots": [
{
"start_at": "2022-04-06T12:00:00Z",
"end_at": "2022-04-06T17:00:00Z"
}
],
"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"
},
"items": [
{
"quantity": 1,
"container_type": "parcel",
"total_weight": {
"value": "2.00",
"unit": "kg"
}
}
],
"reference": "",
"special_instructions": "",
"tracking_number": "PRG220406003404",
"status": "CANCELLED",
"created_at": "2022-03-30T10:57:02.344479Z",
"cancelled_at": "2022-03-30T10:57:11.656260Z",
"carrier_code": "dhl_express",
"contract_id": 10
}
}OAuth2 scopes required:
write:pickup. See Scopes for OAuth apps.How cancellation works
- Carriers that support cancellation via their API: the pickup is canceled with the carrier during the request. If the carrier confirms, the response is
200and the pickup has the statusCANCELLED. If not, the response is409and the pickup has the statusFAILED. - Carriers that Sendcloud Support handles cancellations for: Sendcloud Support cancels the pickup with the carrier on your behalf. The response is
202and the pickup has the statusCANCELLATION_REQUESTED. Once Support has handled the request, the status changes toCANCELLED,CANCELLATION_FAILEDorCANCELLATION_REJECTED, which you can follow with the Retrieve a pickup endpoint. - Other carriers: the pickup can’t be canceled through Sendcloud. The response is
409.
A pickup can’t be canceled once its pickup time has started, or after the carrier’s cancellation deadline.
Authorizations
HTTPBasicAuthOAuth2ClientCreds
Basic Authentication using API key and secrets is currently the main authentication mechanism.
Path Parameters
The id of the pickup you want to cancel.
Response
The carrier has canceled the pickup.
- BRT Pickup Object
- Correos Express Pickup Object
- Correos Express Pickup Object
- DHL Germany Pickup Object
- DHL Express Pickup Object
- DHL Parcel GB Pickup Object
- DHL Parcel Iberia Pickup Object
- DHL Pickup Object
- DPD AT Pickup Object
- DPD Pickup Object
- Fedex Pickup Object
- GLS Italy Object
- Hermes Germany Pickup Response
- Poste Italiane Delivery Pickup request
- UPS Pickup Object
Show child attributes
Show child attributes