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>'
{
  "identifier": "set_insurance",
  "name": "Set insurance",
  "type": "NUMBER",
  "help_text": "",
  "trigger_update": false,
  "possibilities": [
    [
      "<string>"
    ]
  ]
}

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.