Skip to main content
GET
/
shipping-rules
/
actions
/
{identifier}
Retrieve an action
curl --request GET \
  --url https://panel.sendcloud.sc/api/v3/shipping-rules/actions/{identifier} \
  --header 'Authorization: Basic <encoded-value>'
import requests

url = "https://panel.sendcloud.sc/api/v3/shipping-rules/actions/{identifier}"

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/shipping-rules/actions/{identifier}', 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/shipping-rules/actions/{identifier}",
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/shipping-rules/actions/{identifier}"

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/shipping-rules/actions/{identifier}")
.header("Authorization", "Basic <encoded-value>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://panel.sendcloud.sc/api/v3/shipping-rules/actions/{identifier}")

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
{
  "identifier": "set_insurance",
  "name": "Set insurance",
  "type": "NUMBER",
  "help_text": "",
  "trigger_update": false,
  "possibilities": [
    [
      "<string>"
    ]
  ]
}
{
"errors": [
{
"id": "<string>",
"links": {
"about": "<string>"
},
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

identifier
string
required

The stable identifier of the action.

Example:

"set_shipping_method"

Response

OK

An action together with the full list of values it accepts.

identifier
string
required

Stable identifier for the action; use this in action payloads.

Example:

"set_insurance"

name
string
required

Name of the action.

Example:

"Set insurance"

type
string
required

Value type of the action — "SELECT", "TEXT", "NUMBER", …

Example:

"NUMBER"

help_text
string
default:""

Optional explanatory text shown next to the action in the UI.

trigger_update
boolean
default:false

If true, selecting this action should re-fetch dependent possibilities.

possibilities
string[][]

[[key, label], …] for SELECT-typed actions; empty for free-form.