This API is responsible for retrieving detailed information about a specific order. It provides partners with comprehensive order details, including item lists, quantities, prices, statuses, and timestamps. It ensures that partners can track and manage their orders efficiently, keeping them informed about the order status and any updates throughout the order's lifecycle.
For more details on the order flow from creation to delivery, please refer to Partner API → Order Flow Guides.
Model Attributes
| Attribute | Description | Type |
|---|---|---|
| id | the unique identifier of that table entity | Integer |
| app_order_uuid | order unique identifier from the application side | String |
| created_at | Date time of order creation | String in ISO 8601 Format |
| order_status | the current status of an order | String Enum |
| estimated_time | The estimated time for which the order is expected to be done, the estimated time is an integer that represents minutes | Integer |
| full_address | For Delivery orders, the full address of the customer | String or Null |
| lat | For Delivery orders, the latitude of the address of the customer | Float or Null |
| lng | For Delivery orders, the longitude of the address of the customer | Float or Null |
| notes | Any additional notes a customer have on the entire order | String or Null |
| total_price | Order total price | Float |
| service_type | order service type | String Enum |
| payment_type | Order payment type | String Enum |
| payment_status | Order payment statuses | String Enum |
| items | Order items, it follows the same format of creation | Object |
| is_customer_arrived | For Curbside orders, this attribute is updated by both the customer and the waiter. It indicates whether the customer has arrived to receive their order. | Boolean |
| cancellation_reason | For Cancelled orders, this attribute is used to specify the reason for the order cancellation. It's mandatory for cancelled orders and null otherwise | Object or Null |
Order Statuses
The order can be in any of the following statuses, some statuses are meant to be used for specific service types
| Enum Name | Description | Additional Notes |
|---|---|---|
| pending | Order is created but not yet accepted by the company. | By default, all newly created orders are in pending status |
| in_progress | Order was accepted and is being prepared. | |
| ready | Order is ready. | |
| in_route | For Delivery service, indicates that the order is on its way. | Used alongside delivery service type |
| done | Order successfully delivered to the customer | This is the ending status of any successful order. |
| cancelled | Order got cancelled | |
| rejected | Order got rejected by the Company's waiter | |
| company_force_cancelled | Order got force cancelled by the company | This status occurs when a company schedules application uninstall while ongoing orders still exists, these orders gets automatically cancelled with the company_force_cancelled status |
| company_early_cancelled | Order got early cancelled by a company | This status occurs when an order "in pending status" is fired while a company is uninstalling an application |
Service Types
A branch has the ability to offer some services for the integrating applications to use. Each order should specify the service type needed to serve from the list of available services of each branch.
Available service_types are:
| Enum Name |
|---|
| dine_in |
| delivery |
| pick_up |
| curbside |
Payment Types
Payment types are used to specify the way the order was paid. It takes one of 2 values:
| Enum Name | Description |
|---|---|
| cash | order will be paid in cash |
| online | order was paid using an online payment method |
Payment Status
Payment statuses are used to specify the current status of the order payment. It takes one of 2 values:
| Enum Name | Description |
|---|---|
| pending_payment | order is created but not yet paid |
| paid |