- KDS Configuration and User Guide
- KDS Posting Files
- Field Definitions
- Distribution State Record v3 (KDS 3.3 and higher)
Distribution State Record v3 (KDS 3.3 and higher)
A Distribution State Record v3 is appended to the posting
file(s) each time an order’s distribution state changes. This is
introduced in KDS version 3.3.0000.2959.
- Record Format Indicator – Always ‘5.2’.
- Order ID – As sent by the POS. This is a unique string assigned to each order.
- State – Distribution state. Can
be one of the following values:
Value Name Description 0
DS_UNKNOWN*
Unknown state
10
DS_FUTURE_ORDER*
Future Order check
20
DS_ORDERED*
Order has been created with at least one menu item
30
DS_SENT
Order has been sent to the kitchen with at least 1 menu item
40
DS_STARTED*
Order has been started
50
DS_PREP_DONE
Order has been prepared by at least one station
60
DS_READY
Order has been expo done and is ready to be distributed to the customer
70
DS_DISPATCHED*
Order has been transferred to driver
75
DS_UNDISPATCHED*
Order has been undispatched from the driver
80
DS_DELIVERED*
Driver back in store delivery
90
DS_COMPLETE*
Order has been final tendered
100
DS_CANCELLED
Order cancelled (possibly due to a hoax delivery request)
* = For future use; currently unavailable
- State Update Time – The time when the order change (added, done, canceled, or recalled) occurred, represented in Unix Time (number of seconds elapsed since 12:00 AM January 1, 1970 UTC).
- Revenue Center ID – As sent by the POS. This is a unique string for each revenue center.
- Check Number – As sent by the POS. This is a string assigned to each check.
- Order Device ID – ID of the order device where this event is triggered from. This field is blank when the state is DS_CANCELLED.
Parent topic: Field Definitions