getCheckMenuMixRecordsByPage
Retrieve Menu Mix sales data stored at the Check/Recipe Item level of granularity, split across 1-to-many pages using pageNumber. Use to retrieve data in smaller chunks.
Query parameters
A 24-hour period defined in the checkMenuMixHeaderDetails. Use format: dd-MMM-yy.
The number attributed to a guest check within the POS system.
Use true to retrieve detailed information for each Guest Check.
The Code that identifies the Location in Crunchtime.
Retrieve one or more records by pageNumber. Use to retrieve data in smaller chunks. If left blank, the default is 1.
Number of items to display per page.
Specify 'true' to output null data elements.
If 'true', includes empty checks; default value is 'false' (optional).
Headers
Secure token for API authentication.
Password for the Crunchtime Application User.
Crunchtime site identifier. (test or production)
User ID for the Crunchtime Application User.
Optional trace identifier for troubleshooting.
Response
Success
Example response
{
"checkMenuMixDetails": [
{
"checkMenuMixGroupDetails": [
{
"checkMenuMixCheckDetails": [
{
"chargeTips": 9999.99,
"checkCloseTime": "11:30",
"checkOpenTime": "11:30",
"excludeConsumptionFlag": "Y",
"guestCount": 99,
"timeOfSale": "11:30"
}
],
"checkMenuMixItemDetails": [
{
"cost": 55.61,
"itemType": 3,
"parentLineNumber": 9999,
"pluNumber": 9999,
"posLineNumber": 12345,
"posPrice": 9999.9,
"posQuantity": 9999.9,
"posValue": 9999.9,
"productNumber": "R1717_EM",
"recipeName": "TURKEY AVOCADO CLUB_EM",
"timeOfSale": "12:30"
}
],
"checkMenuMixMiscCheckDetails": [
{
"dataValue": "TEST",
"miscId": 9
}
],
"checkMenuMixMiscItemDetails": [
{
"dataValue": "TEST",
"miscId": 9,
"pluNumber": 9999,
"posLineNumber": 12345
}
],
"checkMenuMixTimeDetails": [
{
"posTimeId": 9,
"value": 9
}
]
}
],
"checkMenuMixHeaderDetails": {
"businessDate": "08/11/2019",
"customerCode": "000011",
"locationCode": "000011"
}
}
]
}