HomeGuidesAPI Reference
Log In
API Reference

Use this API to retrieve orders.

Here's a description of all values the input parameter status can take on:

  • unplaced - an order will take on this status if the input parameter place_order is set to false when creating the order using the Create Order API, and the order is not yet finalized using the Finalize Order API.

  • awaiting_confirmation - an order will take on this status if the order was created using the Create Order API and the input parameter place_order is set to true, or if the order was finalized using the Finalize Order API.

  • in_progress - an order will take on this status after taking on the awaiting_confirmation status, once the store has confirmed the order.

  • completed - an order will take on this status after taking on the in_progress status, once the pickup order has been picked up or the delivery order has been delivered.

  • canceled - an order can take on this status after taking on one of the following statuses: awaiting_confirmation, in_progress, completed. Orders can be canceled due to various reasons, such as the store rejecting the order or the delivery service canceling the order due to unavailable delivery drivers.

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