edit_order

Updated September 4, 20261 min read

Patch root order fields via PATCH /orders/{reference}. This tool edits the root order only. Fulfillment-order location, schedule, delivery method, and line-item cancellation have separate tools.

Parameters

NameTypeRequiredDescription
order_idstringYesCarriyo order ID or partner_order_reference.
tenantIdstringYes
billing_addressobjectNo
customerobjectNo
discount_applicationsarrayNo
duties_includedbooleanNo
fulfillment_ordersarrayNo
languagestringNoISO 639-1 language code.
line_itemsarrayNo
merchantstringNo
order_datestringNoOrder date or date-time.
partner_order_referencestringNo
paymentobjectNo
sales_channelstringNo
shipping_linesarrayNo
taxes_includedbooleanNo

Example agent prompt

"Update the order."

edit_order(
  tenantId="…",
  order_id="ORD-2025-0001"
)