cancel_order
Updated September 4, 20261 min read
Cancel an order via POST /orders/{reference}/cancel. Use cancel_fulfillment_order_items instead when only selected fulfillment-order quantities should be cancelled.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
order_id | string | Yes | Carriyo order ID or partner_order_reference. |
tenantId | string | Yes | — |
cancellation_reason | string | No | Values: customer_cancellation, auto_allocation_failed, inventory_out_of_stock, staff_error, payment_issue, other. |
Example agent prompt
"Cancel the order."
cancel_order(
tenantId="…",
order_id="ORD-2025-0001"
)