Skip to main content
GET
/
shop-order-statuses
/
mapping
Retrieve custom status mapping for an integration
curl --request GET \
  --url https://panel.sendcloud.sc/api/v3/shop-order-statuses/mapping \
  --header 'Authorization: Basic <encoded-value>'
import requests

url = "https://panel.sendcloud.sc/api/v3/shop-order-statuses/mapping"

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/shop-order-statuses/mapping', 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/shop-order-statuses/mapping",
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/shop-order-statuses/mapping"

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/shop-order-statuses/mapping")
.header("Authorization", "Basic <encoded-value>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://panel.sendcloud.sc/api/v3/shop-order-statuses/mapping")

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": {
    "integration_id": 23452345,
    "mapping": [
      {
        "status_category": "READY_TO_SEND",
        "external_id": "11",
        "is_valid": true
      },
      {
        "status_category": "IN_TRANSIT",
        "external_id": "11",
        "is_valid": true
      },
      {
        "status_category": "DELIVERED",
        "external_id": null,
        "is_valid": true
      },
      {
        "status_category": "CANCEL",
        "external_id": "1",
        "is_valid": false
      }
    ]
  }
}
{
"errors": [
{
"status": "400",
"code": "non_field_errors",
"title": "integration ID",
"detail": "Integration ID is a required GET parameter"
}
]
}
Only the Prestashop V2 integration is supported.

Authorizations

Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Query Parameters

integration_id
integer
required

Filter response on integration_id.

Example:

251

Response

Custom status mapping for an integration.

Retrieve available shop order statuses mapped onto Sendcloud's internal status category for the given integration.

data
object