list_order_hold_rules
Updated September 30, 20261 min read
List the order hold rules of the tenant via GET /order-hold-rules. Rules are evaluated once, when an order is created, in sequence order (lower sequence first). The first matching ACTIVE rule puts the order on hold with its hold_action; its rule_id is recorded in the order's on_hold_details.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
tenantId | string | Yes | — |
Example agent prompt
"Which rules put our orders on hold?"
list_order_hold_rules(
tenantId="…"
)