list_automation_rulesets

Updated May 21, 20261 min read

List automation rulesets for a tenant.

Automation rules automate carrier selection by matching shipment attributes to conditions. Rules are grouped into rulesets scoped to specific merchant + country combinations. Within a ruleset, rules are evaluated in sequence — first match wins.

This tool returns the ruleset containers. Use list_automation_rules to see the individual rules inside one.

Parameters

NameTypeRequiredDescription
tenantIdstringYesThe tenant.
merchantstringNoFilter by merchant id.
entity_typestringNoFilter by shipment entity type — FORWARD or REVERSE.

If no filters are passed, all rulesets are returned.

Returns

An array of ruleset records — id, name, entity type (FORWARD / REVERSE), merchant + country scope, status.

Example agent prompts

"What automation rulesets do we have?"

list_automation_rulesets(tenantId="…")

"Show me forward-shipment rulesets for the Acme merchant."

list_automation_rulesets(
  tenantId="…",
  merchant="acme",
  entity_type="FORWARD"
)

Common chain

When the question is "why was SHP-12345 routed to DHL?":

get_shipment              (find the ruleset id from the shipment record)
       │
       ▼
get_automation_ruleset    (confirm scope and status)
       │
       ▼
list_automation_rules     (sequence-ordered rule list)
       │
       ▼
narrate which rule matched