CancelledOrder
The order as it stands after a cancellation, plus who cancelled it and when.
Fields
- idstring
Sous Chef's identifier for the order (uuid).
- platformOrderIdstring
The id the order has on the platform or channel it came from: the order id a channel partner sent when it placed the order. Absent when the platform sends none.
- statusstring
Current state of the order.
Possible values: [new, future, ready, finished, rejected, cancelled] - deliveryStatusstring
Delivery progress, where the platform transmits it.
Possible values: [ASSIGNED, EN_ROUTE_TO_STORE_LOCATION, EN_ROUTE_TO_CUSTOMER, COMPLETED, CANCELED] - createdAtstring<date-time>
When the order record was created, ISO-8601 UTC.
- updatedAtstring<date-time>
When the order record last changed, ISO-8601 UTC.
- estimatedReadyAtstring<date-time>
When the kitchen expects the order to be ready, ISO-8601 UTC. Set when Sous Chef accepts the order, from the kitchen's preparation time. A scheduled order carries its scheduled time.
Carried on the order webhooks. Absent when no estimate exists, and on
fetchOrder. - rejectReasonstring
Why the order was rejected, in words (on
order.rejectedonly). For example "Order at 23:10 is outside business hours". - rejectReasonCodestring
Why the order was rejected, as a code (on
order.rejectedonly). It isstoreClosed, which covers a paused store and an order outside the store's hours.Possible values: [itemOutOfStock, storeClosed, kitchenBusy, other] - storeOrderStore
The storefront the order arrived through: which brand, at which kitchen, on which platform.
On
fetchOrder; not on the order webhooks. - cancellationOrderCancellation
Who cancelled the order, why and when. On
fetchOrder, present on every order whosestatusiscancelledand on no other. Theorder.cancelledwebhook carries the same facts as top-level fields of its payload instead. - detailsOrderDetails
What was ordered and what it cost: items with their modifiers, promotions, and the order's subtotal, tax, tip, delivery fee and total in cents.
On
fetchOrder; not on the order webhooks. - bystring
Who cancelled the order.
- reasonstring
Why the order was cancelled, as reported by the cancelling party.
- reasonCodestring
Why the restaurant cancelled the order, as a code. Set when
byiskitchen, beside the free-textreason. Absent for a cancellation by you.Possible values: [itemOutOfStock, storeClosed, kitchenBusy, other] - atstring<date-time>
When the cancellation happened, ISO-8601 UTC.