Software
      Back to home
      1. Logic Controls Product Support
      2. Software

      XML template and tag descriptions:

      The integration between POS software and KitchenGo software suite is simple and fast. All you need to do is generate an order file that uses XML file format then send it to KitchenGo through either share folder or TCP/IP. Please check XML order sample and its format below for detail.

      All Bematech KDS software communicates with POS by accepting an XML file via folder drop or TCP/IP. Some characters are generally reserved to indicate markup such that they cannot be used for character data. These characters are <, >, and &. Sometimes single and double quotes are also considered as reserved characters. To use those characters in the XML string please use the replacements as follow:

       • &lt; instead of <

      • &gt; instead of >

      • &amp; instead of &

      • &apos; instead of '

      • &quot; instead of "

      • &#37; instead of %

      Note: For node properties, you should NOT convert single or double quotes to &apos; or &quot;. For example, version="1.0", encoding="UTF-8", BG="10", FG="255"

      After creating the XML file, you may use Internet browser to open and see whether it complies with XML standard.

      Tag Description
      <Transaction> </Transaction> Start & End of XML file
      <Order> </Order> Start & End of XML order, everything inside these two tags are order content
      <ID>198</ID> Order ID or Item ID: order id must be unique in whole system; item id must be unique in whole order; (can be string or integer )
      <PosTerminal>2</PosTerminal> Information on PosTerminal
      <TransType>n</TransType>

      Tells which type the order/item is, when it is in order level, there are 3 total types. When n=1: Add new order; When n=2: Delete this order, other tags can be any value or don't need to be included; When n=3: modify this order, simply include all changed tag. If tag value is empty, KDS will deal this tag as unchanged;

       

      When TransType is used in the item level, there are 3 total types.

      When n=1: Add a new item;

      When n=2: Delete this item;

      When n=3: modify this item.

       

      When TransType is used at the condiment level, there are 3 total types.

      When n=1: Add a new condiment;

      When n=2: Delete this condiment;

      When n=3: modify this condiment.
      <OrderType>string</OrderType> Tells which type the order is, when the string is empty, it is Normal order; when string=RUSH, it is RUSH order; When string=Fire, it is Fire order.
      <ServerName>Tom</ServerName> Information on serverName(operator)
      <Destination>DineIn</Destination> Order destination
      <GuestTable>S:01</GuestTable> Table information
      <UserInfo>userinfo</UserInfo> Information on User can be used to display a message
      <Customer>John</Customer> Start and end of the customer information. Everything inside these tags are for customer information
      Customer ID

      <ID>1</ID>      		 ID number that is unique under the customer group tag
      <Name>John</Name> Customers name. (Not yet in use)
      <Phone>15555555555</Phone> Phone number used for SMS messaging. Twilio integration.
      <Address>123 Smith st</Address> Customers address. (Not yet in use)
      <Address2>Suite 100</Address2> Customers building or suite Number. (Note yet in use)
      <City>Albany</City> Customers city. (Not yet in use)
      <State>NY</State> Customers state. (Note yet in use)
      <Zip>11451</Zip> Customers Zip code. (Note yet in use)
      <Item></Item> Start & End of item, everything inside these two tags are item content
      Item ID

      <ID>1</ID>      		 This ID must be unique within the order. EX: if you have 3 items in one order the ID must be different for each item.
      <PreparationTime>1</PreparationTime> Start & End of preparationTime, used for smart order., input type is double, unit in minutes. E.G.: 1.5
      <Name>Pasta Salad Supreme</Name> Item name
      <Quantity>1</Quantity> Item quantity
      <KDSStation>n:n</KDSStation> x:0 or x:1, x stands for which station you want the order to be, 0 stands for screen 1 and 1 stands for screen 2, support multiple station with 5:0,4:1 this will send order to both station 4 and 5
      <PreModifier>Seat 1 </PreModifier> Start & End of item PreModifier, everything inside these two tags are item PreModifier
      <S0>Order Message 0</S0> Message contents of message 0
      <Condiment></Condiment> Start & End of item condiment, everything inside these two tags are item condiment
      Condiment ID

      <ID>1</ID>      		 This ID must be unique within the order. EX: if you have 3 condiments in one order the ID must be different for each item.