Epson KDS Expansion Box KD-IB01 KDS User Manual - KDS API
Epson KDS Expansion Box KD-IB01 Manual
View all Epson KDS Expansion Box KD-IB01 manuals
Add to My Manuals
Save this manual to your list of manuals |
Epson KDS Expansion Box KD-IB01 manual content summary:
- Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 1
111-38-URM-009 KDS API User Manual EPSON is a registered trademark and EPSON Exceed Your Vision is a registered logomark of Seiko Epson Corporation. All all rights in these marks. Copyright 2022 Seiko Epson Corporation. Form: F-730-028 v1.00 KDS API User Manual Page 1 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 2
...23 8. Status of Callback ...24 8.1. POS Request...24 8.2. KDS Response ...24 9. Callback behavior in multistation mode 25 Form: F-730-028 v1.00 KDS API User Manual Page 2 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 3
printer. Each POS system that the Epson KDS supports requires a "parser" module to understand the are already supported. There is no integration with the POS required. For a POS that is not supported it is 80: http://192.168.192.168/cgi-bin/kdsapi/service.cgi HTTP POST (MAIN DELIVERY OPTION) - JSON - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 4
POS parser would still listen to the traditional port inputs -> Serial, USB, or Ethernet. The KDS API service is listening on port 80. A POS parser needs to be selected when configuring the KDS. If a this specification. Form: F-730-028 v1.00 KDS API User Manual Page 4 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 5
the server name should be kept small so as to be displayed fully in the order header. Form: F-730-028 v1.00 KDS API User Manual Page 5 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 6
. The best practice is for the first item in the list to have an id of 1 and then increase for every item. Numbers 1-99 are supported. Form: F-730-028 v1.00 KDS API User Manual Page 6 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 7
This field is optional. If it is not there then no seat # will be displayed. Numbers 1-99 are supported. If "qty" field is sent and "seat" is not then the Epson KDS should be configured to show the text in the alert color. Form: F-730-028 v1.00 KDS API User Manual Page 7 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 8
", "modifierlist" : [ { "modifier" : "No salt", "colour" : "alert" } ] }, { "itemid" : 3, "qty" : 1, "seat" : "3", "item" : "Coke", "modifierlist" : [ { "modifier" : "Regular" }, { "modifier" : "No ice" } ] } ] } Form: F-730-028 v1.00 KDS API User Manual Page 8 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 9
• 9 - invalid json parameter • 10 - missing json parameter • 101 - data format error • 104 - timeout, no response from kds Form: F-730-028 v1.00 KDS API User Manual Page 9 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 10
"alert" } ] }, { "itemid" : 6, "label" : "--- Course 2 ---" }, { "itemid" : 7, "qty" : 1, "seat" : "3", "item" : "Coke", "modifierlist" : [ { "modifier" : "Regular" }, { "modifier" : "No ice" } ] } ] } Form: F-730-028 v1.00 KDS API User Manual Page 10 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 11
KDS response KDS will send back a response indicating success or failure. Response errorcodes are listed in Section 4.3. Form: F-730-028 v1.00 KDS API User Manual Page 11 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 12
request Status of particular order(s) can be obtained from the KDS system by sending a status order request. Form: F-730-028 v1.00 KDS API User Manual Page 12 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 13
" : "15" } ] } If orderslist is missing, then it implies all active orders and they will all be returned. Form: F-730-028 v1.00 KDS API User Manual Page 13 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 14
the order to be bumped or voided, and it would remain the same for subsequent POS requests. Form: F-730-028 v1.00 KDS API User Manual Page 14 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 15
" : "5555555555", "cust_email" : "[email protected]", "state" : "active", "elapsedtime" : 120, "timeout" : "normal", "activeitemcount" : 2, "bumpeditemcount" : 1, "voideditemcount" : 1, "totalitemcount" : 4 } ] } Form: F-730-028 v1.00 KDS API User Manual Page 15 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 16
" : "3", "item" : "Fries", }, { "itemid" : 4, "state" : "voided" "qty" : 1, "seat" : "4", "item" : "Coke", }, { "itemid" : 5, "state" : "active" "qty" : 1, "seat" : "1", "item" : "Classic Burger", } ] } ] } Form: F-730-028 v1.00 KDS API User Manual Page 16 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 17
a bump takes place. o "onpriority" - when the timer of order reaches Priority Time, KDS will return check, table. Form: F-730-028 v1.00 KDS API User Manual Page 17 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 18
" KDS Response KDS will send back a response indicating success or failure. Response errorcodes are listed in Section 4.3. Form: F-730-028 v1.00 KDS API User Manual Page 18 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 19
" : "alert" }, { "modifier" : "> NO Mushrooms" } ] }, { "itemid" : 2, "label" : "- Also sent to:Station 1" }, { "itemid" : 3, "label" : "- Also sent to:Pizza Oven" } ] } Form: F-730-028 v1.00 KDS API User Manual Page 19 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 20
", "cust_phone" : "5555555555", "cust_email" : "[email protected]", "itemlist" : [ { "itemid" : 8, "qty" : 1, "seat" : "2", "item" : "Classic Burger", "modifierlist" : [ { "modifier" : "No pickle" } ] } ] } Form: F-730-028 v1.00 KDS API User Manual Page 20 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 21
: { "type" : "void", "check" : "0025", "table" : "Table 15", "server" : "Mark"," "cust_name" : "Robert", "cust_phone" : "5555555555", "cust_email" : [email protected] } Form: F-730-028 v1.00 KDS API User Manual Page 21 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 22
KDS will send check, table of that order. { "type" : "callback", "callbackid" : 2, "trigger" : "onpriority", "check" : "12", "table" : "Table 7" } Form: F-730-028 v1.00 KDS API User Manual Page 22 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 23
" : "[email protected]" } 7.7. POS/Server Response The Epson KDS ignores the response from the POS or Server. Form: F-730-028 v1.00 KDS API User Manual Page 23 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 24
error, then errorcode will be non-zero with appropriate description. List of error conditions are in Section 4.3. Form: F-730-028 v1.00 KDS API User Manual Page 24 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 25
all item unbump from all devices Same as KDS Routing With Display Same as Slave Not generating Form: F-730-028 v1.00 KDS API User Manual Page 25 of 26 111-38-URM-009 R2.50 - Epson KDS Expansion Box KD-IB01 | KDS User Manual - KDS API - Page 26
This page is purposely left blank. Form: F-730-028 v1.00 KDS API User Manual Page 26 of 26 111-38-URM-009 R2.50
KDS API
User Manual
Page 1 of 26
111-38-URM-009
R2.50
Form: F-730-028 v1.00
EPSON is a registered trademark and EPSON Exceed Your Vision is a registered logomark of Seiko Epson Corporation. All other
product and brand names are trademarks and/or registered trademarks of their respective companies. Epson disclaims any and all
rights in these marks. Copyright 2022 Seiko Epson Corporation.
111-38-URM-009
KDS API
User Manual