Get order channel daily totals
post
/bi/v1/{orgIdentifier}/getOrderChannelDailyTotals
The API gets the Order Channel Daily Totals 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 : requestPayload
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
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : ocDailyTotals
Type:
objectThe response body contains information about the daily operational totals by order channels for the specified location and business date.
Show Source
-
busDt(required):
string(date)
Title:
Business DateBusiness date -
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 order channel daily totals by revenue centers
Nested Schema : revenueCenters
Type:
arrayAn array of order channel daily totals by revenue centers
Show Source
-
Array of:
object ocDailyTotalsByRVC
The response body contains daily operational totals by order channels at a revenue center for the specified location and business date.
Nested Schema : ocDailyTotalsByRVC
Type:
objectThe response body contains daily operational totals by order channels at a revenue center for the specified location and business date.
Show Source
-
orderChannels(required):
array orderChannels
An array of daily operational totals by order channels for a revenue center. This attribute will not be returned in the response if value is null.
First available version 20.1.15
-
rvcNum(required):
integer
Title:
Revenue Center NumberMaximum Length:10Revenue Center number. This attribute will not be returned in the response if orderChannels is null
Nested Schema : orderChannels
Type:
arrayAn array of daily operational totals by order channels for a revenue center. This attribute will not be returned in the response if value is null.
Show Source
First available version 20.1.15
-
Array of:
object ocDailyTotal
The response body contains daily operational totals by order channel for a revenue center for the specified location and business date.
Nested Schema : ocDailyTotal
Type:
objectThe response body contains daily operational totals by order channel for a revenue center for the specified location and business date.
Show Source
-
chkClsdCnt(required):
integer
Title:
Check Closed CountMaximum Length:16Number of checks that were were closed in the day -
chkCnt(required):
integer
Title:
Check CountMaximum Length:16Total number of checks for the day. This attribute will not be returned in the response if value is 0 or null -
chkOpnCnt(required):
integer
Title:
Check Open CountMaximum Length:16Number of checks that were were rung in the day which remain in open state -
dineTimeInMins(required):
number
Title:
Dine Time in minutesMaximum Length:16Total dining time for the day in minutes. This attribute will not be returned in the response if value is 0 or null -
dscTtl(required):
number
Title:
Item Discount TotalTotal of item discounts for the day. This attribute will not be returned in the response if value is 0 or null -
errCorCnt(required):
integer
Title:
Error Correct CountMaximum Length:16Number of items which were error corrected for the day. This attribute will not be returned in the response if value is 0 or null -
errCorTtl(required):
number
Title:
Error Correct TotalTotal of items which were error corrected for the day. This attribute will not be returned in the response if value is 0 or null -
gstCnt(required):
integer
Title:
Guest CountMaximum Length:16Total number of guests for the day. This attribute will not be returned in the response if value is 0 or null -
mngrVdCnt(required):
integer
Title:
Manager Void CountMaximum Length:16Number of items which were voided by the manager of the employee. This attribute will not be returned in the response if value is 0 or null -
mngrVdTtl(required):
number
Title:
Manager Void TotalTotal items which were voided by the manager of the employee. This attribute will not be returned in the response if value is 0 or null -
netSlsTtl(required):
number
Title:
Net Sales TotalTotal of net sales for the day -
nonRevSvcTtl(required):
number
Title:
Non Revenue Service Charge TotalNon-revenue service charge, and non-revenue menu item total. This attribute will not be returned in the response if value is 0 or null -
ocNum:
integer
Title:
Order Channel numberMaximum Length:16Unique identifier of the order channel. This attribute will not be returned in the response if value is 0 or null.First available version 20.1.15
-
otNum(required):
integer
Title:
Order Type NumberMaximum Length:16Order Type number -
parkCarCnt(required):
integer
Title:
Parked Car CountMaximum Length:16Total number of cars parked for the day. This attribute will not be returned in the response if value is 0 or null -
prepCostTtl(required):
number
Title:
Prepartion Cost totalTotal of preparation cost for the day. This attribute will not be returned in the response if value is 0 or null -
rtnCnt(required):
integer
Title:
Return CountMaximum Length:16Total number of items returned in the day. This attribute will not be returned in the response if value is 0 or null -
rtnTtl(required):
number
Title:
Return TotalTotal value of returned items for the day. This attribute will not be returned in the response if value is 0 or null -
sosTime1(required):
integer
Title:
SOS Time 1Maximum Length:16SOS time 1. This attribute will not be returned in the response if value is 0 or null -
sosTime2(required):
integer
Title:
SOS Time 2Maximum Length:16SOS time 2. This attribute will not be returned in the response if value is 0 or null -
sosTime3(required):
integer
Title:
SOS Time 3Maximum Length:16SOS time 3. This attribute will not be returned in the response if value is 0 or null -
sosTime4(required):
integer
Title:
SOS Time 4Maximum Length:16SOS time 4. This attribute will not be returned in the response if value is 0 or null -
svcTtl(required):
number
Title:
Service Charge TotalTotal of service charges for the day. This attribute will not be returned in the response if value is 0 or null -
taxCollTtl(required):
number
Title:
Tax Collected TotalTotal of tax collected for the day. This attribute will not be returned in the response if value is 0 or null -
taxCredTtl(required):
number
Title:
Tax Credited TotalTax credit totals (negative transactions with tax) for the day. This attribute will not be returned in the response if value is 0 or null -
tblTurnCnt(required):
integer
Title:
Table Turn CountMaximum Length:16Total number of tables turns for the day. This attribute will not be returned in the response if value is 0 or null -
transCnclCnt(required):
integer
Title:
Transaction Cancel CountMaximum Length:16Number of transactions that were cancelled for the day. This attribute will not be returned in the response if value is 0 or null -
transCnclTtl(required):
number
Title:
Transaction Cancel TotalTotal of transactions that were cancelled for the day. This attribute will not be returned in the response if value is 0 or null -
vdCnt(required):
integer
Title:
Void CountMaximum Length:16Number of items voided for the day. This attribute will not be returned in the response if value is 0 or null -
vdTtl(required):
number
Title:
Void TotalTotal of items voided for the day. This attribute will not be returned in the response if value is 0 or null
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 all the order type daily totals 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/getOrderChannelDailyTotals
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:
{
"locRef": "1234",
"busDt": "2020-07-20",
"revenueCenters":[{
"rvcNum": 1372,
"orderChannels": [{
"ocNum": 2,
"otNum": 12345,
"netSlsTtl": 1234.56,
"dscTtl": 1234.56,
"svcTtl": 1234.56,
"nonRevSvcTtl": 1234.56,
"taxColTtl": 1234.56,
"taxCredTtl": 1234.56,
"prepCost": 1234.56,
"rtrnCnt": 123,
"rtrnTtl": 1234.56,
"chkCnt": 123,
"gstCnt": 123,
"tblTurnCnt": 123,
"dineTimeInMins": 34,
"parkCarCnt": 123,
"vdTtl": 1234.56,
"vdCnt": 123,
"errCorTtl": 1234.56,
"errCorCnt": 123,
"mngrVdTtl": 1234.56,
"mngrVdCnt": 123,
"transCnclTtl": 123.45,
"transCnclCnt": 1,
"chkOpnCnt": 1234,
"chkClsdCnt": 1234,
"sosTime1": 1234,
"sosTime2": 1234,
"sosTime3": 1234,
"sosTime4": 1234
}]
}]
}