Retrieve an integration
curl --request GET \
--url https://panel.sendcloud.sc/api/v3/integrations/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://panel.sendcloud.sc/api/v3/integrations/{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/integrations/{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/integrations/{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/integrations/{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/integrations/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://panel.sendcloud.sc/api/v3/integrations/{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": 23452345,
"shop_name": "Integration #1",
"shop_url": "https://www.my-shop-integration.com/",
"type": "api",
"started_failing_at": "2023-11-10T16:16:42Z",
"last_fetched_at": "2023-11-10T16:15:09Z",
"created_at": "2023-11-04T14:15:22Z",
"updated_at": "2023-11-08T12:23:56Z",
"service_point_enabled": true,
"service_point_carriers": [
"ups",
"dhl"
],
"webhook_active": true,
"webhook_url": "https://my-shop-integration.integrator/api/webhooks/sendcloud",
"feedback_type": "eager"
}
}{
"errors": [
{
"status": 404,
"code": "not_found",
"title": "Not Found",
"detail": "The Integration could not be found with the search criteria given"
}
]
}Manage integrations
Retrieve an integration
Get a valid integration from the Sendcloud system
GET
/
integrations
/
{id}
Retrieve an integration
curl --request GET \
--url https://panel.sendcloud.sc/api/v3/integrations/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://panel.sendcloud.sc/api/v3/integrations/{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/integrations/{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/integrations/{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/integrations/{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/integrations/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://panel.sendcloud.sc/api/v3/integrations/{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": 23452345,
"shop_name": "Integration #1",
"shop_url": "https://www.my-shop-integration.com/",
"type": "api",
"started_failing_at": "2023-11-10T16:16:42Z",
"last_fetched_at": "2023-11-10T16:15:09Z",
"created_at": "2023-11-04T14:15:22Z",
"updated_at": "2023-11-08T12:23:56Z",
"service_point_enabled": true,
"service_point_carriers": [
"ups",
"dhl"
],
"webhook_active": true,
"webhook_url": "https://my-shop-integration.integrator/api/webhooks/sendcloud",
"feedback_type": "eager"
}
}{
"errors": [
{
"status": 404,
"code": "not_found",
"title": "Not Found",
"detail": "The Integration 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 integration ID
Required range:
x >= 1Response
Retrieved integration corresponding to the provided integration_id
Integration object as represented in the response of the get request.
Integration object.
Show child attributes
Show child attributes
⌘I