Collecting a completed order

The tickets and food and beverage items in a completed standard order have a NotCollected status until one of the following events occurs:

Collecting at POS or Kiosk

A completed standard order can be collected at POS or Kiosk by displaying a barcode with the booking ID of the order.

Use the GetCompletedOrder endpoint to retrieve the booking ID for a completed standard order.

Copy
Copied
{
  "order": {
    "id": "string",
    "type": "Standard",
    "status": "Completed",
    "booking": {
      "id": "string",
      "mode": "Paid"
    }
  }
}
NOTE

Some properties have been omitted from the code snippet above for brevity.

When displaying a barcode for linked orders, use the booking ID of the parent order to ensure all linked child orders can also be collected at POS or Kiosk.

Marking an order as collected

A completed order can be marked as collected via the SetOrderAsCollected endpoint.

When marking a parent order as collected, the includeChildOrders request property can be set to true to also mark all linked child orders as collected.

Copy
Copied
{
  "includeChildOrders": true
}

Requesting item delivery preparation

The items assigned to an item delivery that requires preparation will be marked as Collected as soon as the item delivery is sent to the kitchen for preparation.

See item delivery preparation for more info.