List Orders

Retrieve a list of orders with optional filtering and pagination.

Only want to retrieve Draft Orders? Explore state based filtering.

To retrieve only draft orders you will need to send the request with the query parameter is_booked set to false, which results in this request: api/orders?is_booked=false. There are also other state based filters that can be worth exploring - e.g. is_cancelled, is_shipped or is_ready_for_shipping.

Learn about Filtering and Optimizing Queries

Receiving large response pay loads on list endpoints? Check out our guides on "Optimizing Queries" and "Filtering & Sorting" to learn how to only receive the data that you need.

Language
Click Try It! to start a request and see the response here!