hold_fulfillment_order
Updated September 30, 20261 min read
Put one fulfillment order on hold for review via POST /orders/{reference}/fulfillment-orders/{fulfillment_order_id}/on-hold. Only a fulfillment order with status open or allocated can be held, and only while the order itself is not on hold. While it is on hold, every update to that fulfillment order is rejected until release_fulfillment_order_hold; release_order_hold does not release it, because the order itself is not on hold. Use hold_order instead to hold the whole order.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
fulfillment_order_id | string | Yes | Carriyo fulfillment order ID or partner_fulfillment_order_reference. |
order_id | string | Yes | Carriyo order ID or partner_order_reference. |
tenantId | string | Yes | — |
assigned_to | object | No | User or team that should review the hold. |
notes | string | No | Why the hold was placed. |
priority | string | No | Values: LOW, NORMAL, HIGH, URGENT. |
sla_hours | integer | No | Hours from now by which the hold should be reviewed. Sets sla_timestamp. |
Example agent prompt
"Hold the fulfillment order until the stock count is confirmed."
hold_fulfillment_order(
tenantId="…",
order_id="ORD-2025-0001",
fulfillment_order_id="FO-2025-0001",
notes="Waiting for stock count"
)