Skip to content

Order Management API ​

The Order Management API provides endpoints to retrieve, create, and track orders placed in your store, manage line items, and coordinate shipment logistics.

Endpoints ​

EndpointMethodPathDescription
Fetch OrdersGET/v1/ordersRetrieve paginated list of store orders
Create Merchant OrderPOST/v1/ordersCreate an order programmatically for a customer
Fetch Order by Order NumberGET/v1/orders/{orderNumber}/showGet order details by human-readable number
Fetch Order DetailGET/v1/orders/{orderId}/detailFull order detail for merchant
Fetch Order Line ItemsGET/v1/orders/{orderId}/itemsList line items in an order
Cancel Line ItemPATCH/v1/orders/{orderId}/items/{lineId}/cancelCancel an individual order line item
Update Order StatusPATCH/v1/orders/{orderId}/statusTransition order status
Get Order StatusesGET/v1/orders/statusesList all supported order status codes
Fetch Customer OrdersGET/v1/customer-ordersOrders placed by authenticated customer
Fetch Orders by Customer IDGET/v1/customer-orders/{customerId}Orders placed by a specific customer ID
Fetch Customer Order ItemsGET/v1/customer-orders/{orderId}/itemsLine items in customer order
Track Order HistoryGET/v1/order-status-history/{orderNumber}Public order tracking timeline
Generate Order WaybillPOST/v1/orders/{orderId}/logistics/waybillGenerate logistics shipment waybill
Track ShipmentGET/v1/orders/{orderId}/logistics/trackingLive shipment tracking with carrier

Build with joy