Retrieve a pickup
curl --request GET \
--url https://panel.sendcloud.sc/api/v3/pickups/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://panel.sendcloud.sc/api/v3/pickups/{id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://panel.sendcloud.sc/api/v3/pickups/{id}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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}"
req, _ := http.NewRequest("GET", 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.get("https://panel.sendcloud.sc/api/v3/pickups/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://panel.sendcloud.sc/api/v3/pickups/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"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
}
}Pickups
Retrieve a pickup
Retrieve information about a specific pickup based on the pickup id.
GET
/
pickups
/
{id}
Retrieve a pickup
curl --request GET \
--url https://panel.sendcloud.sc/api/v3/pickups/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://panel.sendcloud.sc/api/v3/pickups/{id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://panel.sendcloud.sc/api/v3/pickups/{id}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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}"
req, _ := http.NewRequest("GET", 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.get("https://panel.sendcloud.sc/api/v3/pickups/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://panel.sendcloud.sc/api/v3/pickups/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"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
}
}OAuth2 scopes required:
read:pickup. See Scopes for OAuth apps.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 retrieve.
Response
OK
- 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