Sign in

v1

latestOpenAPI 3.0.12026-08-062555238.4 KB
Order API endpoints

Fetch order's details by ID

Use this endpoint to fetch an order's details by its ID.

get/orders/{order_id}

Path parameters

order_idinteger required

Headers

Authorizationstring required
User-Agentstring required
Brand-Idstring
Branch-Idstring required

Response

Order retrieved successfully

idinteger required

The id of the order

status'pending' | 'accepted' | 'cancelled' | 'delivered' required

The current status of the order

merchant_pay_typestring

Payment type for captain

delivery_type'careem' | 'merchant'

Delivery type for the order which could be either Careem or Merchant aka Self delivery. Self Delivery allows certain restaurants to deliver orders using their own rider fleet. POS APIs support self-delivery configuration.

notesstring

Customer notes

cash_innumber

amount to be collected from customer if payment_type for customer is cash

cancellation_reasonstring

The cancellation reason. This field is populated when the order is cancelled

created_atstring required

Time RFC3339 format in UTC in which the brand has been updated

is_scheduledboolean

true if the order is scheduled

prepare_timestring

Time RFC3339 format in UTC at which the restaurant would start to prepare the order

pickup_timestring

Time RFC3339 format in UTC at which the order would be picked up from the restaurant

updated_atstring required

Time RFC3339 format in UTC in which the brand has been updated