Skip to main content
NameTypeDescription
idstringUnique identifier of the order
shortIdstringShorter identifier of this order optimized for human-readability. May be non unique (extremely rare).
status#order-statusThe current status of the order
createdAtTimeTime at which the order was created in the backend
updatedAtTimeTime of the most recent update to the order
serviceType”collection” | “delivery”How the customer wishes to receive his order
channelstringThe channel the order was created on (Whatsapp, Uber, POS…)
customerNotesstring (optional)Notes from the customer about this order
deliveryAddressaddress.md (optional)Address to which the customer wants this order to be delivered
totalprice.mdOrder total price (With charges, discounts, etc…)
itemsorder-items.mdItems in the order
deliverydelivery.md (optional)Information on the delivery if it exists
paymentpayment.md (optional)Payment information for the order

Order status

The status of the order can be in the following states:
StatusDescription
awaiting_paymentThe order is not official yet, it has been confirmed by the customer but have not been payed.
newThe default state for a new incoming order.
receivedThis state marks the order as received by the restaurant and awaiting for confirmation.
acceptedThe order have been accepted by the restaurant (Usually automatic, some restaurant may want manual validation of the order)
in_preparationThe order is being prepared in the kitchen. (Usually orders do not go through this state and it is mainly used for integration purpose with other POS systems).
awaiting_shipmentThe order is ready and waiting for the delivery Carier.
awaiting_collectionThe order is ready and is waiting for the customer to pick it up.
in_deliveryThe order is in delivery. If the delivery is handled with our system or with our third party integration (i.e. Chaskis or Uber Direct). The status of the delivery can be checked from the order’s delivery object
completedThe customer have received the order. Everything went well. Work is done.
rejectedThe order was rejected by the restaurant.
cancelledThe order was cancelled either by the restaurant or by the customer for some reason. (Unlike rejected reaching this status is probably not intentional and is due to some problem)
delivery_failedThe delivery of the order failed.