Skip to main content
PATCH
Update a shipping rule

Authorizations

Authorization
string
header
required

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

Path Parameters

rule_id
integer<int64>
required

The unique id of the shipping rule.

Required range: x >= 1
Example:

1

Body

application/json

Payload to update a shipping rule. Omit any field to leave it unchanged.

name
string | null

New name for the rule; omit to leave unchanged.

Maximum string length: 100
is_active
boolean | null

New active flag; omit to leave unchanged.

criteria
RuleCriteriaInput · object | null

Replacement criteria block; omit to keep the existing criteria.

actions
RuleActionInput · object[] | null

Replacement actions list; omit to keep the existing actions.

Response

OK

A shipping rule including its conditions and actions.

id
integer
required

ID of the rule.

Example:

1

name
string
required

Name of the rule.

Example:

"Insure high-value parcels"

is_active
boolean
required

Whether the rule is currently evaluating shipments.

Example:

true

is_invalid
boolean
required

True when the rule cannot be evaluated (e.g. references an unavailable property or action).

Example:

false

order
integer | null

Position in the organization's evaluation order; lower values are evaluated first.

Example:

1

updated_at
string<date-time> | null

Timestamp of the last update to the rule.

Example:

"2026-06-26T10:15:00Z"

criteria
RuleCriteriaDetail · object | null

Criteria that determine when this rule fires.

actions
RuleActionDetail · object[]

Actions executed when the rule fires.