cancel_fulfillment_order_items

Updated September 22, 20261 min read

Cancel selected fulfillment-order item quantities via POST /orders/{reference}/fulfillment-orders/{fulfillment_order_id}/cancel.

Parameters

NameTypeRequiredDescription
cancellation_reasonstringYesValues: customer_cancellation, auto_allocation_failed, inventory_out_of_stock, staff_error, payment_issue, other.
fulfillment_order_idstringYesCarriyo fulfillment order ID or partner_fulfillment_order_reference.
line_itemsarrayYesItems to cancel, by id or product identifier, with quantity.
order_idstringYesCarriyo order ID or partner_order_reference.
tenantIdstringYes

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=…
)