Retrieve a list of pickups
curl --request GET \
--url https://panel.sendcloud.sc/api/v3/pickups \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://panel.sendcloud.sc/api/v3/pickups"
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', 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",
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"
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")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://panel.sendcloud.sc/api/v3/pickups")
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,
"time_slots": [
{
"start_at": "2022-04-06T12:00:00Z",
"end_at": "2022-04-06T17:00:00Z"
}
],
"country": "NL",
"carrier_code": "dhl_express",
"tracking_number": "PRG220406003404",
"status": "CANCELLED",
"created_at": "2022-03-30T10:57:02.344479Z",
"cancelled_at": "2022-03-30T10:57:11.656260Z"
},
{
"id": 2,
"time_slots": [
{
"start_at": "2022-04-06T12:00:00Z",
"end_at": "2022-04-06T17:00:00Z"
}
],
"country": "NL",
"carrier_code": "dhl_express",
"tracking_number": "PRG220406002044",
"status": "CANCELLED",
"created_at": "2022-03-30T09:20:37.957495Z",
"cancelled_at": "2022-03-30T09:20:45.433367Z",
"contract_id": 10
}
]
}Pickups
Retrieve a list of pickups
Get information about all the pickups which have been created from your account.
This endpoint uses cursor-based pagination via Link headers. See Pagination for details.
GET
/
pickups
Retrieve a list of pickups
curl --request GET \
--url https://panel.sendcloud.sc/api/v3/pickups \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://panel.sendcloud.sc/api/v3/pickups"
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', 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",
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"
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")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://panel.sendcloud.sc/api/v3/pickups")
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,
"time_slots": [
{
"start_at": "2022-04-06T12:00:00Z",
"end_at": "2022-04-06T17:00:00Z"
}
],
"country": "NL",
"carrier_code": "dhl_express",
"tracking_number": "PRG220406003404",
"status": "CANCELLED",
"created_at": "2022-03-30T10:57:02.344479Z",
"cancelled_at": "2022-03-30T10:57:11.656260Z"
},
{
"id": 2,
"time_slots": [
{
"start_at": "2022-04-06T12:00:00Z",
"end_at": "2022-04-06T17:00:00Z"
}
],
"country": "NL",
"carrier_code": "dhl_express",
"tracking_number": "PRG220406002044",
"status": "CANCELLED",
"created_at": "2022-03-30T09:20:37.957495Z",
"cancelled_at": "2022-03-30T09:20:45.433367Z",
"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.
Query Parameters
Amount of pickups that will be shown per page.
Required range:
1 <= x <= 100Example:
10
Response
200 - application/json
OK
Show child attributes
Show child attributes