release_order_hold

Updated September 30, 20261 min read

Release the hold on an order via POST /orders/{reference}/release-on-hold. The order itself must be on hold; when only a fulfillment order is held, use release_fulfillment_order_hold instead. Releasing the order also releases every fulfillment order on it that is held. The order and its fulfillment orders return to the status they had before the hold.

Parameters

NameTypeRequiredDescription
order_idstringYesCarriyo order ID or partner_order_reference.
tenantIdstringYes—
notesstringNoWhy the hold was released.

Example agent prompt

"Release the hold on order ORD-2025-0001, the address is verified."

release_order_hold(
  tenantId="…",
  order_id="ORD-2025-0001",
  notes="Address verified with the customer"
)