Skip to main content
GET
/
shipping-rules
/
conditions
/
{identifier}
Retrieve a condition property
curl --request GET \
  --url https://panel.sendcloud.sc/api/v3/shipping-rules/conditions/{identifier} \
  --header 'Authorization: Basic <encoded-value>'
{
  "identifier": "destination_country",
  "name": "Destination country",
  "operators": [
    {
      "identifier": "greater_than",
      "name": "Greater than",
      "multiple": false,
      "unary": false,
      "help_text": ""
    }
  ],
  "type": "SELECT",
  "help_text": "",
  "multiple": false,
  "delimiter": "",
  "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 condition property.

Example:

"total_order_value"

Response

OK

Property metadata plus the full value table for SELECT-typed properties.

​
identifier
string
required

Stable identifier for the property; use this in condition payloads.

Example:

"destination_country"

​
name
string
required

Name of the property.

Example:

"Destination country"

​
operators
OperatorConfig · object[]
required

Operators compatible with this property, with multiple precomputed for the pair.

​
type
string
required

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

Example:

"SELECT"

​
help_text
string
default:""

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

​
multiple
boolean
default:false

Whether the property can take multiple values in a single condition.

​
delimiter
string
default:""

Delimiter used when multiple values are encoded as a single string.

​
trigger_update
boolean
default:false

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

​
possibilities
string[][]

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