cancel_fulfillment_order_items
Updated May 21, 20261 min read
Cancel selected fulfillment-order item quantities via POST /orders/{reference}/fulfillment-orders/{fulfillment_order_id}/cancel.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
cancellation_reason | string | Yes | Values: CUSTOMER_CANCELLATION, AUTO_ALLOCATION_FAILED, INVENTORY_OUT_OF_STOCK, STAFF_ERROR, PAYMENT_ISSUE, OTHER. |
fulfillment_order_id | string | Yes | Target fulfillment order ID. |
line_items | array | Yes | — |
order_id | string | Yes | Carriyo order ID or partner_order_reference. |
tenantId | string | Yes | — |
key | string | No | Values: order_id, partner_order_reference. |
Example agent prompt
"Cancel the fulfillment order items."
cancel_fulfillment_order_items( tenantId="…", order_id="ORD-2025-0001", fulfillment_order_id="FO-2025-0001", cancellation_reason=…, line_items=… )