Orders tools
Updated September 9, 20261 min read
7 tools for the top-level order entity. Fulfillment-order operations (splits, merges, location moves, scheduling, fulfilling, shipping) are in the separate Fulfillment orders family.
Reads
| Tool | What it returns |
|---|---|
get_order | One order by Carriyo order_id or partner_order_reference. |
list_orders | Orders with paging, sorting, search, and merchant filters. |
Writes
| Tool | What it does |
|---|---|
create_order | Create a new order. |
edit_order | Patch root order fields. To change items, use the fulfillment-order tools. |
cancel_order | Cancel an order and all its fulfillment orders. |
fulfill_order | Fulfill every pending item on the order, one shipment per fulfillment order. |
unfulfill_order | Reverse every fulfillment on the order and cancel its shipments. |
Related families
- Fulfillment orders. The operational actions: split, merge, fulfill, ship, cancel items, change location / delivery method, schedule.
- Shipments. Once a fulfillment order ships, the resulting shipment is the unit of carrier interaction.