Order
An order is one shipment due to a customer. Each order carries the delivery address, the customer, the subscription it came from (if any) and its line items, so one call gives you all you need to ship it.
An API endpoint to get a page of the orders of your shop. Archived orders are left out. Filter by status and by date range; order by id, due_date or created_on. Dates are in the timezone of your shop.
Query parameters
pageoptionalintegerPage number
Defaults to 1.
per_pageoptionalintegerOrders per page
Defaults to 15.
order_byoptionalstringField to order by
Possible values: id, due_date, created_on.
Defaults to "id".
directionoptionalstringOrder direction
Possible values: asc, desc.
Defaults to "asc".
statusoptionalOrderStatusNameOnly orders with this status
Possible values: awaiting_delivery, shipped, returned, dispute, future_shipment, cancelled, payment_failed.
idoptionalintegerOnly the order with this ID
start_created_onoptionalstringOnly orders created at or after this date and time
Format: Y-m-d\TH:i:s.
end_created_onoptionalstringOnly orders created at or before this date and time
Format: Y-m-d\TH:i:s.
start_due_dateoptionalstringOnly orders due at or after this date and time
Format: Y-m-d\TH:i:s.
end_due_dateoptionalstringOnly orders due at or before this date and time
Format: Y-m-d\TH:i:s.
ReturnsOrderList
A page of orders
Error responses
401MessageThe API key is missing or wrong
422ValidationErrorThe body or the query failed validation
An API endpoint to update up to 50 orders in one call: set the status, the carrier and the tracking number. Send status: shipped with dispatch_shipped_email: 1 to also email the customer that the order shipped. Every order must belong to your shop, or the whole request fails validation.
Request body
idRequiredinteger[]IDs of the orders to update, 50 at most
statusoptionalOrderStatusNameStatus of an order
Possible values: awaiting_delivery, shipped, returned, dispute, future_shipment, cancelled, payment_failed.
dispatch_shipped_emailoptionalintegerSend 1 with status: shipped to email the customer that the order shipped. Nothing is sent for other statuses or when the order did not change.
Possible values: 0, 1.
Defaults to 0.
carrieroptionalstring | nullName of the carrier
carrier_serviceoptionalstring | nullService of the carrier, e.g. Express
tracking_numberoptionalstring | nullReturnsMessage
The orders were updated
messagestringError responses
401MessageThe API key is missing or wrong
422ValidationErrorThe body or the query failed validation
An API endpoint to get one order by ID, with its delivery address, customer, subscription, line items and shipping method.
Path parameters
idRequiredintegerOrder ID
ReturnsOrder
The order
Error responses
401MessageThe API key is missing or wrong
404MessageNo order with this ID in your shop