{
"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"
}
]
}{
"errors": [
{
"id": "<string>",
"links": {
"about": "<string>"
},
"status": "<string>",
"code": "unknown_field",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}Create a shipping rule
Create a shipping rule that applies its actions to a shipment whenever the shipment matches its conditions.
{
"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"
}
]
}{
"errors": [
{
"id": "<string>",
"links": {
"about": "<string>"
},
"status": "<string>",
"code": "unknown_field",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}Authorizations
Basic Authentication using API key and secrets is currently the main authentication mechanism.
Body
Payload to create a shipping rule.
Name of the rule.
100"Insure high-value parcels"
Conditions that determine when the rule's actions are applied.
Show child attributes
Show child attributes
Actions performed on a shipment when the criteria match.
Show child attributes
Show child attributes
Whether the rule should evaluate against shipments after creation.
Response
Created
A shipping rule including its conditions and actions.
ID of the rule.
1
Name of the rule.
"Insure high-value parcels"
Whether the rule is currently evaluating shipments.
true
True when the rule cannot be evaluated (e.g. references an unavailable property or action).
false
Position in the organization's evaluation order; lower values are evaluated first.
1
Timestamp of the last update to the rule.
"2026-06-26T10:15:00Z"
Criteria that determine when this rule fires.
Show child attributes
Show child attributes
Actions executed when the rule fires.
Show child attributes
Show child attributes