QSR

6 | QSR Terminology Mapping

This article covers a brief description of all the terminology used by QSR and how it can be mapped to Bepoz database.

This article covers a brief description of all the terminology used by QSR and how it can be mapped to Bepoz database.

Prerequisite

N/A


Field Mapping

Check Mapping

 

QSR Name

Data Type

QSR Description

Bepoz Field Mapping

Bepoz Notes

SiteUID String A globally unique identifier for a site that will be provided by QSR KDSLink.exe config field
  • This is provided in by QSR. 
  • This will be entered in the KDSLink.exe configuration for QSR
CheckNumber Integer The Check Number TransactionID or TableID
  • If the transaction is a table transaction, send through the TableID as the check number
  • If the transaction is a non table transaction, send through the TransactionID
Courses Collection of Course An array pf course information. See data fields of course table  
  • Refer to Course Mapping
LastUpdateTime String When the check was last changed in ISO 8601 format and UTC Time zone Transactions.DateUpdated  

Course Mapping    

 

QSR Name

Data Type

QSR Description

Bepoz Field Mapping

Bepoz Notes

CourseName String The course name    
CourseNumber Integer The course number 0
  • Always send zero (as per QSR request)
CustomerName String The customer name

Account Name

Table.Name

 
DestinationID Number The destination ID of the course StoreID
  • Numeric Value associated with the "Destination" on the POS- typically refers to an "Order Type", "Profit Center", or delivery location in the POS application
  • Examples of typical destinations in Quick Services are Drive Thru, Dine In, or Delivery
  • Examples of typical destinations in Table Services are Dine In, Take Out, Bar or Catering
  • The Destination ID id defined in the CSK configuration
GuestCount Integer The guest count of the course    
Items Collection of Item

An array of items included in the course

See Data Field of Item Table

   
PaymentStates Collection of CoursePaymentState An array of payment states. See Data Field of CoursePaymentyState Table    
Server Complex Includes the server ID and name. See
Data Fields of Server table.
Operator.FirstName  
TableName String The table name    
TableSection String The table number    
Terminal Integer The terminal of the course Workstation.WorkstationID  
IsTraining Boolean Indicates whether course is training See notes When an order is sent in training mode, mark this flag true
IsVoid Boolean Indicates if the course is void See notes  

Server Mapping

 

QSR Mapping

Data Type

QSR Description

Bepoz Field Mapping

Bepoz Notes

ID Integer The server ID number Operator.OperatorID  
Name String The server name Operator.FirstName  

Item Mapping

 

QSR Name

Data Type

QSR Description

Bepoz Field Mapping

Bepoz Notes

ItemNumber Integer The item number in the course    
ParentItemNumber Integer The ItemNumber of an item's parent. Will be 0 (zero) if the item does not have a parent. See ItemNumber in this table See notes
  • Leave as zero for normal item
  • If it is a charged condiment, set the productid of the base product that the condiment is being sold under
ItemType String The type of item. ItemType options are "FoodItem", "ComboItem", "PieceDetail", "MixedItem", "SideItem", "Condiment", "PizzaSection", "PrepModifier", "Allergen". If ItemType string is empty or invalid, default ItemType "FoodItem" will be used. See notes
  • Leave blank to default to FoodItem for a normal product
  • If it is a charged condiment, use PrepModifier
ItemID Integer The item's ID number (also known as the PLU). Product.ProductID + SizeNum -1
  • This will be the product id joined with the size - 1. For eg. ProductID 1 with size 1 will be 10. Product ID 1 with size 10 will be 19
  • These will be unique numbers always. For example Product ID 10 with size 1 will be 100 and ProductID 100 with size 1 will be 1000
Seat Integer The seat number associated with the item Translines.SeatNum
  • Use the translines field for data field
Quantity Integer The quantity of the item Translines.UnitQtySold
  • Use the translines field for data field
UnitPrice Integer The unit price of the item Translines.NettEach
  • Use the translines field for data field.
IdealCookTimes Array[Integer] The ideal cook time of the item, in seconds. Up to four cook times can be defined in the array Product.PrepTime
  • Use the translines field for data field
CookTimeModifierType String
  • Only applicable when ItemType is PrepModifier
  • The type of cook time modifier to apply to the PrepModifier's parent item. Accepted values are  "NoModification", "Percentage", "Value", "Override". If string is empty or invalid,default CookTimeModifierType "NoModification" is used
   
CookTimeModifierValue Integer Only applicable when ItemType is PrepModifier and CookTimeModifierType is Value or Percentage. The amount of time, in seconds, that should be substituted as the cook time of the PrepModifier's parent item    
IsFreeItem Boolean Indicates whether item is free See notes
  • If the product item Nett is zero priced then set this to 1
  • Otherwise, set to zero

Description String The item description Product.Name
  • This should follow the name as set in the Printer Format
  • I.e. Short Name, Long Name, 2nd Name
DestinationID Integer The destination ID of the item See Notes
  • This will be the con
IsVoid Boolean Indicates if Item is void See Notes