Skip to main content

Order Cancelation

Overview​

Although validation helps prevent unfulfillable orders from being accepted, there are cases when an order needs to be canceled after acceptance.

DSP/Stream -> POS Cancelations​

When a cancelation is initiated by the DSP or through Stream, you will receive an order.canceled event to the Handle Order (Stream -> POS) endpoint.

Example Event​

{
  "type": "order.canceled",
  "object": {
    "provider_id": "pos-order-123",
    "location_id": "location-456",
    "cancel_reason": "item_out_of_stock"
  }
}

The object may include:

  • cancel_reason (optional): The normalized reason the DSP gave for the cancellation, for surfacing context to operators and for your own reporting. One of the normalized values (e.g. customer_requested, item_out_of_stock, store_closed, driver_unavailable, other). Absent when the DSP provided no reason — treat a missing field as "reason unknown" and do not fail the cancelation. See full payload

Cancelation Best Practices​

  • Notify staff: Ensure kitchen staff are aware of canceled orders