API Reference

getCheckMenuMixRecordsByPage

get
https://webservices-test.net-chef.com/checkmenumix/v1/getCheckMenuMixByPage

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 Params
string
required

A 24-hour period defined in the checkMenuMixHeaderDetails. Use format: dd-MMM-yy.

string

The number attributed to a guest check within the POS system.

boolean
Defaults to false

Use true to retrieve detailed information for each Guest Check.

string

The Code that identifies the Location in Crunchtime.

int32
Defaults to 1

Retrieve one or more records by pageNumber. Use to retrieve data in smaller chunks. If left blank, the default is 1.

int32

Number of items to display per page.

boolean

Specify 'true' to output null data elements.

boolean
Defaults to false

If 'true', includes empty checks; default value is 'false' (optional).

Headers
string
required

Secure token for API authentication.

string
required

Password for the Crunchtime Application User.

string
required

Crunchtime site identifier. (test or production)

string
required

User ID for the Crunchtime Application User.

string

Optional trace identifier for troubleshooting.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 5 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json
Updated 5 months ago