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(required): string
Unique identifier of the organization name
The request body defines the details of the API request.
Root Schema : kdsRequestPayload
Type:
objectRequest payload
Show Source
-
applicationName:
string
Title:
Application NameMaximum Length:128The name of the application which is accessing the API.First Available Version: 20.1.10
-
busDt(required):
string(date)
Title:
Business DateThe business date associated with the cash management detail -
include:
string
Title:
IncludeMaximum Length:2000List of objects to include in response -
locRef(required):
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
searchCriteria:
string
Title:
Search CriteriaMaximum Length:2000Search criteria to filter results based on field value -
transSinceUTC:
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:
objectThe response body contains information about the Kitchen Performance for the specified location.
Show Source
-
busDt(required):
string(date)
Title:
Business DateBusiness Date -
curUTC(required):
string(date-time)
Title:
Current UTC Date timeCurrent UTC Date Time -
locRef(required):
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
revenueCenters(required):
array revenueCenters
An array of kitchen display orders
Nested Schema : revenueCenters
Type:
arrayAn 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:
objectThe response body contains KDS Orders information about a revenue center for the specified location.
Show Source
-
orders(required):
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(required):
integer
Title:
Revenue Center NumberMaximum Length:10Revenue Center number. This attribute will not be returned in the response if orders is null
Nested Schema : orders
Type:
arrayAn 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:
objectThe response body contains KDS Order about a revenue center for the specified location.
Show Source
-
guestCheckId(required):
integer
Title:
Guest check IDMaximum Length:16Unique ID of the Guest Check -
highPriorityFlag(required):
boolean
Title:
High Priority FlagA flag indicating if this was rush order. This attribute will not be returned in the response if value is false or null -
isAppetizerFlag(required):
boolean
Title:
Is Appetizer FlagA 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(required): integer
-
prepTimeInSecs(required):
integer
Title:
Preparation Time in SecondsMaximum Length:16Time taken to preapre the kitchen order in seconds -
recallCount(required):
integer
Title:
Recall CountMaximum Length:16The number of menu items recalled in the order. This attribute will not be returned in the response if value is 0 or null -
serviceRoundNum(required):
integer
Title:
Service Round NumberMaximum Length:16The Service Round Number of the order -
startTime(required):
string(date-time)
Title:
Start TimeThe start time of the kitchen order. This attribute will be deprecated in future. Please use startTimeLcl instead -
startTimeLcl(required):
string(date-time)
Title:
Start Time LocalThe start time of the kitchen order in the location's timezone.First Available Version: 20.1.9.6
-
startTimeUTC(required):
string(date-time)
Title:
Start Time UTCThe UTC start time of the kitchen order.First Available Version: 20.1.9.6
-
stationName(required):
string
Title:
Station NameMaximum Length:99Name of the station -
subOrders(required):
array subOrders
An array of KDS suborders for a KDS order
Nested Schema : subOrders
Type:
arrayAn 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:
objectThe response body contains KDS Sub-Order about a revenue center for the specified location.
Show Source
-
actualPrepTimeinSecs(required):
integer
Title:
Actual Preparation Time in SecondsMaximum Length:16Actual Time taken to preapre the kitchen order in seconds -
miDefSeq(required):
integer
Title:
Menu Item Definition SequenceMaximum Length:16Sequence of the menu item in the order -
miMod(required):
string
Title:
Menu Item ModifierMaximum Length:99SIPS menu item preparation time of the sub order. This attribute will not be returned in the response if value is null -
miNum(required):
integer
Title:
Menu Item NumberMaximum Length:16Unique identifier of the menu item -
miPrepTimeInSecs(required):
integer
Title:
Menu Item Preparation Time in SecondsMaximum Length:16SIPS menu item preparation time of the sub order -
postTimeLcl(required):
string(date-time)
Title:
Posting time LocalDate and time of the line item was posted in the KDS in the location's timezone.First Available Version: 20.1.9.6
-
postTimeUTC(required):
string(date-time)
Title:
Posting time in UTC formatUTC time of the line item was posted in the KDS -
subOrderId(required):
integer
Title:
Sub Order IDMaximum Length:16Unique identifier of the sub order
400 Response
Bad Request
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
401 Response
Unauthorized
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
403 Response
Service Unavailable
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
404 Response
Resource Not Found
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
Default Response
Unexpected Error
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe 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"
}]
}]
}]
}