Skip to main content
GET
/
shipping-rules
/
rules
Retrieve a list of shipping rules
curl --request GET \
  --url https://panel.sendcloud.sc/api/v3/shipping-rules/rules \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": [
    {
      "id": 1,
      "name": "Insure high-value parcels",
      "is_active": true,
      "is_invalid": false,
      "order": 1,
      "updated_at": "2026-06-26T10:15:00Z",
      "criteria": {
        "is_and": true,
        "conditions": [
          {
            "property": "total_order_value",
            "operator": "greater_than",
            "compare_to": "100"
          }
        ]
      },
      "actions": [
        {
          "identifier": "set_insurance",
          "value": "500"
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
active
boolean | null

Filter rules by active state; omit to return both active and inactive rules.

​
cursor
string

The cursor query string is used as the pivot value to filter results. If no value is provided, the first page of results will be returned. To get this value, you must encode the offset, reverse and position into a base64 string.

There are 3 possible parameters to encode:

  • o: Offset
  • r: Reverse
  • p: Position

For example, r=1&p=300 encoded as a base64 string would be cj0xJnA9MzAw. The query string would then be cursor=cj0xJnA9MzAw.

Example:

"cj0xJnA9MzAw"

​
page_size
integer

The size of the page to fetch.

Required range: x <= 200

Response

200 - application/json

OK

A page of shipping rules.

​
data
RuleDetail · object[]
required

Rules on the current page, in evaluation order.