Retrieve an order
curl --request GET \
--url https://panel.sendcloud.sc/api/v3/orders/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://panel.sendcloud.sc/api/v3/orders/{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/orders/{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/orders/{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/orders/{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/orders/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://panel.sendcloud.sc/api/v3/orders/{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": "669",
"order_id": "555413",
"created_at": "2018-02-27T10:00:00.555Z",
"modified_at": "2018-02-27T10:00:00.555Z",
"order_number": "OXSDFGHTD-12",
"order_details": {
"integration": {
"id": 739283
},
"status": {
"code": "fulfilled",
"message": "Fulfilled"
},
"order_created_at": "2018-02-27T10:00:00.555Z",
"order_updated_at": "2018-02-27T10:00:00.555Z",
"order_items": [
{
"name": "Cylinder candle",
"measurement": {
"weight": {
"value": 1,
"unit": "kg"
}
},
"quantity": 1,
"unit_price": {
"value": 3.5,
"currency": "EUR"
},
"total_price": {
"value": 3.5,
"currency": "EUR"
},
"delivery_dates": {
"handover_at": "2022-02-27T10:00:00.555309+00:00",
"deliver_at": "2022-03-02T11:50:00.555309+00:00"
},
"mid_code": "US1234567",
"material_content": "100% Cotton",
"intended_use": "Personal use",
"manufacturer_product_id": "ABC-12345",
"manufacturer_product_id_std": "01234567890128"
}
]
},
"payment_details": {
"is_cash_on_delivery": true,
"total_price": {
"value": 7,
"currency": "EUR"
},
"status": {
"code": "paid",
"message": "Order has been paid"
},
"discount_granted": {
"value": "3.99",
"currency": "EUR"
},
"insurance_costs": {
"value": "9.99",
"currency": "EUR"
},
"freight_costs": {
"value": "5.99",
"currency": "EUR"
},
"other_costs": {
"value": "2.99",
"currency": "EUR"
}
},
"customs_details": {
"commercial_invoice_number": "0124-03102022",
"shipment_type": "commercial_goods",
"export_type": "commercial_b2c",
"tax_numbers": {
"sender": [
{
"name": "VAT",
"country_code": "NL",
"value": "NL987654321B02"
}
],
"receiver": [
{
"name": "VAT",
"country_code": "DE",
"value": "DE123456789B03"
}
],
"importer_of_record": [
{
"name": "VAT",
"country_code": "NL",
"value": "NL975318642B01"
}
]
}
},
"shipping_address": {
"name": "John Doe",
"address_line_1": "Stadhuisplein",
"house_number": "15",
"postal_code": "5341TW",
"city": "Oss",
"country_code": "NL"
}
}
}{
"errors": [
{
"status": "404",
"code": "not_found",
"title": "Not found",
"detail": "The order could not be found with the search criteria given"
}
]
}Orders
Retrieve an order
Find a specific order by its order ID.
GET
/
orders
/
{id}
Retrieve an order
curl --request GET \
--url https://panel.sendcloud.sc/api/v3/orders/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://panel.sendcloud.sc/api/v3/orders/{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/orders/{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/orders/{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/orders/{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/orders/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://panel.sendcloud.sc/api/v3/orders/{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": "669",
"order_id": "555413",
"created_at": "2018-02-27T10:00:00.555Z",
"modified_at": "2018-02-27T10:00:00.555Z",
"order_number": "OXSDFGHTD-12",
"order_details": {
"integration": {
"id": 739283
},
"status": {
"code": "fulfilled",
"message": "Fulfilled"
},
"order_created_at": "2018-02-27T10:00:00.555Z",
"order_updated_at": "2018-02-27T10:00:00.555Z",
"order_items": [
{
"name": "Cylinder candle",
"measurement": {
"weight": {
"value": 1,
"unit": "kg"
}
},
"quantity": 1,
"unit_price": {
"value": 3.5,
"currency": "EUR"
},
"total_price": {
"value": 3.5,
"currency": "EUR"
},
"delivery_dates": {
"handover_at": "2022-02-27T10:00:00.555309+00:00",
"deliver_at": "2022-03-02T11:50:00.555309+00:00"
},
"mid_code": "US1234567",
"material_content": "100% Cotton",
"intended_use": "Personal use",
"manufacturer_product_id": "ABC-12345",
"manufacturer_product_id_std": "01234567890128"
}
]
},
"payment_details": {
"is_cash_on_delivery": true,
"total_price": {
"value": 7,
"currency": "EUR"
},
"status": {
"code": "paid",
"message": "Order has been paid"
},
"discount_granted": {
"value": "3.99",
"currency": "EUR"
},
"insurance_costs": {
"value": "9.99",
"currency": "EUR"
},
"freight_costs": {
"value": "5.99",
"currency": "EUR"
},
"other_costs": {
"value": "2.99",
"currency": "EUR"
}
},
"customs_details": {
"commercial_invoice_number": "0124-03102022",
"shipment_type": "commercial_goods",
"export_type": "commercial_b2c",
"tax_numbers": {
"sender": [
{
"name": "VAT",
"country_code": "NL",
"value": "NL987654321B02"
}
],
"receiver": [
{
"name": "VAT",
"country_code": "DE",
"value": "DE123456789B03"
}
],
"importer_of_record": [
{
"name": "VAT",
"country_code": "NL",
"value": "NL975318642B01"
}
]
}
},
"shipping_address": {
"name": "John Doe",
"address_line_1": "Stadhuisplein",
"house_number": "15",
"postal_code": "5341TW",
"city": "Oss",
"country_code": "NL"
}
}
}{
"errors": [
{
"status": "404",
"code": "not_found",
"title": "Not found",
"detail": "The order could not be found with the search criteria given"
}
]
}Authorizations
HTTPBasicAuthOAuth2ClientCreds
Basic Authentication using API key and secrets is currently the main authentication mechanism.
Path Parameters
Filtering on the Sendcloud order ID
Required range:
x >= 1Response
OK
Sendcloud Order object
Show child attributes
Show child attributes
⌘I