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

ToolWhat it returns
get_orderOne order by Carriyo order_id or partner_order_reference.
list_ordersOrders with paging, sorting, search, and merchant filters.

Writes

ToolWhat it does
create_orderCreate a new order.
edit_orderPatch root order fields. To change items, use the fulfillment-order tools.
cancel_orderCancel an order and all its fulfillment orders.
fulfill_orderFulfill every pending item on the order, one shipment per fulfillment order.
unfulfill_orderReverse every fulfillment on the order and cancel its shipments.
  • 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.