get_order_hold_rule
Updated September 30, 20261 min read
Get a single order hold rule by ID via GET /order-hold-rules/{rule_id}. Returns the full rule including all conditions and the hold_action. Use the rule_id from an order's on_hold_details to see why the order was held. Returns 404 when the rule has since been deleted.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
rule_id | string | Yes | Order hold rule ID |
tenantId | string | Yes | — |
Example agent prompt
"Why was order ORD-2025-0001 put on hold?"
get_order_hold_rule(
tenantId="…",
rule_id="…"
)