Get kitchen display system details
post
/bi/v1/{orgIdentifier}/getKDSDetails
Get all the Kitchen Display System details for a specified location and business date.
Request
Path Parameters
-
orgIdentifier: string
Unique identifier of the organization name
The request body defines the details of the API request.
Root Schema : kdsRequestPayload
Type:
object
Request payload
Show Source
-
applicationName(optional):
string
Title:
Application Name
Maximum Length:128
The name of the application which is accessing the API.First Available Version: 20.1.10
-
busDt:
string(date)
Title:
Business Date
The business date associated with the cash management detail -
include(optional):
string
Title:
Include
Maximum Length:2000
List of objects to include in response -
locRef:
string
Title:
Location Reference
Maximum Length:99
The location reference, this may be a store number or name depending on the organization -
searchCriteria(optional):
string
Title:
Search Criteria
Maximum Length:2000
Search criteria to filter results based on field value -
transSinceUTC(optional):
string(date-time)
Report all Kitchen Display System transaction activity that has occurred since this UTC date and time for the specified business date.If this object is not included, return all Kitchen Display System transaction activity for the specified business date
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : kdsDetails
Type:
object
The response body contains information about the Kitchen Performance for the specified location.
Show Source
-
busDt:
string(date)
Title:
Business Date
Business Date -
curUTC:
string(date-time)
Title:
Current UTC Date time
Current UTC Date Time -
locRef:
string
Title:
Location Reference
Maximum Length:99
The location reference, this may be a store number or name depending on the organization -
revenueCenters:
array revenueCenters
An array of kitchen display orders
Nested Schema : revenueCenters
Type:
array
An array of kitchen display orders
Show Source
-
Array of:
object kdsOrdersByRVC
The response body contains KDS Orders information about a revenue center for the specified location.
Nested Schema : kdsOrdersByRVC
Type:
object
The response body contains KDS Orders information about a revenue center for the specified location.
Show Source
-
orders:
array orders
An array of KDS orders for a revenue center. This attribute will not be returned in the response if value is null
-
rvcNum:
integer
Title:
Revenue Center Number
Maximum Length:16
Revenue Center number. This attribute will not be returned in the response if orders is null
Nested Schema : orders
Type:
array
An array of KDS orders for a revenue center. This attribute will not be returned in the response if value is null
Show Source
-
Array of:
object kdsOrder
The response body contains KDS Order about a revenue center for the specified location.
Nested Schema : kdsOrder
Type:
object
The response body contains KDS Order about a revenue center for the specified location.
Show Source
-
guestCheckId:
integer
Title:
Guest check ID
Maximum Length:16
Unique ID of the Guest Check -
highPriorityFlag:
boolean
Title:
High Priority Flag
A flag indicating if this was rush order. This attribute will not be returned in the response if value is false or null -
isAppetizerFlag:
boolean
Title:
Is Appetizer Flag
A Boolean flag indicating if the order contained an appetizer item. This attribute will not be returned in the response if value is false or null - menuItemCount: integer
-
prepTimeInSecs:
integer
Title:
Preparation Time in Seconds
Maximum Length:16
Time taken to preapre the kitchen order in seconds -
recallCount:
integer
Title:
Recall Count
Maximum Length:16
The number of menu items recalled in the order. This attribute will not be returned in the response if value is 0 or null -
serviceRoundNum:
integer
Title:
Service Round Number
Maximum Length:16
The Service Round Number of the order -
startTime:
string(date-time)
Title:
Start Time
The start time of the kitchen order. This attribute will be deprecated in future. Please use startTimeLcl instead -
startTimeLcl:
string(date-time)
Title:
Start Time Local
The start time of the kitchen order in the location's timezone.First Available Version: 20.1.9.6
-
startTimeUTC:
string(date-time)
Title:
Start Time UTC
The UTC start time of the kitchen order.First Available Version: 20.1.9.6
-
stationName:
string
Title:
Station Name
Maximum Length:99
Name of the station -
subOrders:
array subOrders
An array of KDS suborders for a KDS order
Nested Schema : subOrders
Type:
array
An array of KDS suborders for a KDS order
Show Source
-
Array of:
object kdsSubOrder
The response body contains KDS Sub-Order about a revenue center for the specified location.
Nested Schema : kdsSubOrder
Type:
object
The response body contains KDS Sub-Order about a revenue center for the specified location.
Show Source
-
actualPrepTimeinSecs:
integer
Title:
Actual Preparation Time in Seconds
Maximum Length:16
Actual Time taken to preapre the kitchen order in seconds -
miDefSeq:
integer
Title:
Menu Item Definition Sequence
Maximum Length:16
Sequence of the menu item in the order -
miMod:
string
Title:
Menu Item Modifier
Maximum Length:99
SIPS menu item preparation time of the sub order. This attribute will not be returned in the response if value is null -
miNum:
integer
Title:
Menu Item Number
Maximum Length:16
Unique identifier of the menu item -
miPrepTimeInSecs:
integer
Title:
Menu Item Preparation Time in Seconds
Maximum Length:16
SIPS menu item preparation time of the sub order -
postTimeLcl:
string(date-time)
Title:
Posting time Local
Date and time of the line item was posted in the KDS in the location's timezone.First Available Version: 20.1.9.6
-
postTimeUTC:
string(date-time)
Title:
Posting time in UTC format
UTC time of the line item was posted in the KDS -
subOrderId:
integer
Title:
Sub Order ID
Maximum Length:16
Unique identifier of the sub order
400 Response
Bad Request
Root Schema : exceptionDetailType
Type:
object
Error details
Show Source
-
detail(optional):
string
Title:
Error description
The description of the error -
o:errorCode:
integer
Title:
Oracle error code
Oracle error code -
status(optional):
integer
Title:
Status
HTTP response code -
title:
string
Title:
Title
High level description of the error -
type:
string
Title:
Type
The description of the type of HTTP error
401 Response
Unauthorized
Root Schema : exceptionDetailType
Type:
object
Error details
Show Source
-
detail(optional):
string
Title:
Error description
The description of the error -
o:errorCode:
integer
Title:
Oracle error code
Oracle error code -
status(optional):
integer
Title:
Status
HTTP response code -
title:
string
Title:
Title
High level description of the error -
type:
string
Title:
Type
The description of the type of HTTP error
403 Response
Service Unavailable
Root Schema : exceptionDetailType
Type:
object
Error details
Show Source
-
detail(optional):
string
Title:
Error description
The description of the error -
o:errorCode:
integer
Title:
Oracle error code
Oracle error code -
status(optional):
integer
Title:
Status
HTTP response code -
title:
string
Title:
Title
High level description of the error -
type:
string
Title:
Type
The description of the type of HTTP error
404 Response
Resource Not Found
Root Schema : exceptionDetailType
Type:
object
Error details
Show Source
-
detail(optional):
string
Title:
Error description
The description of the error -
o:errorCode:
integer
Title:
Oracle error code
Oracle error code -
status(optional):
integer
Title:
Status
HTTP response code -
title:
string
Title:
Title
High level description of the error -
type:
string
Title:
Type
The description of the type of HTTP error
Default Response
Unexpected Error
Root Schema : exceptionDetailType
Type:
object
Error details
Show Source
-
detail(optional):
string
Title:
Error description
The description of the error -
o:errorCode:
integer
Title:
Oracle error code
Oracle error code -
status(optional):
integer
Title:
Status
HTTP response code -
title:
string
Title:
Title
High level description of the error -
type:
string
Title:
Type
The description of the type of HTTP error
Examples
The following example shows how to view the Kitchen performance for a specified location & business date by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H "Authorization: Bearer" -H "Content-Type:application/json" -d {"locRef":"1234","busDt":"2020-10-20"} https://baseurl/bi/v1/orgidentifier/getKDSDetails
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Date: Tue, 20 Oct 2020 21:24:33 GMT Transfer-Encoding: chunked Content-Type: application/json
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "curUTC": "2019-07-20T17:59:59", "locRef": "1234", "busDt": "2020-07-20", "revenueCenters":[{ "rvcNum": 1372, "orders":[{ "guestCheckId": 137243, "stationName": "Station 1", "startTime": "2019-07-20T15:59:59", "startTimeUTC": "2019-07-20T14:59:59", "startTimeLcl": "2019-07-20T10:59:59", "serviceRoundNum": 1, "prepTimeInSecs": 1234, "isAppetizerFlag": false, "menuItemCount": 5, "recallCount": 1, "highPriorityFlag": true, "subOrders":[{ "subOrderId": 123, "miDefSeq": 1, "miNum": 123, "postTimeUTC": "2019-07-20T14:59:59", "postTimeLcl": "2019-07-20T10:59:59", "actualPrepTimeInSecs": 123, "miPrepTimeInSecs": 123, "miMod": "Menu Item Modifier" }] }] }] }