edit_order
Updated May 21, 20261 min read
Patch root order fields via PATCH /orders/{reference}. If using partner_order_reference, pass key=partner_order_reference. This tool edits the root order only. Fulfillment-order location, schedule, delivery method, and line-item cancellation have separate tools.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
order_id | string | Yes | Carriyo order ID or partner_order_reference. |
tenantId | string | Yes | — |
billing_address | object | No | — |
customer | object | No | — |
discount_applications | array | No | — |
duties_included | boolean | No | — |
fulfillment_orders | array | No | — |
key | string | No | Values: order_id, partner_order_reference. |
language | string | No | ISO 639-1 language code. |
line_items | array | No | — |
merchant | string | No | — |
order_date | string | No | Order date or date-time. |
partner_order_reference | string | No | — |
payment | object | No | — |
sales_channel | string | No | — |
shipping_lines | array | No | — |
taxes_included | boolean | No | — |
Example agent prompt
"Update the order."
edit_order( tenantId="…", order_id="ORD-2025-0001" )