getDailyPrepsByPage
Retrieves all Daily Prep transactions with the accompanying information by page number.
Query parameters
The Location where the Daily Prep transaction is created.
Date that the Daily Prep transaction is recorded for inventory (optional). If not provided, all transactions for the location with a prep date greater than or equal to the current date will be returned.
Daily Prep status (Completed, Incomplete or Canceled) to retrieve (optional).
Template Name selected for the Daily Prep transaction (optional). Required if using Template Location Code.
Template Location Code selected for the Daily Prep transaction (optional). Required if using Template Name.
Prep Station Name selected for the Daily Prep transaction (optional). This value is stored in recipe details.
Daily Prep description (optional). The value is case-insensitive but must otherwise match exactly.
Name of the Prep Customer selected for the Daily Prep transaction (optional).
Start time of the Daily Prep transaction as selected when the transaction was created (optional). Format HH:mm (24hr)
Date that the Daily Prep transaction was created (optional).
Application User who created the transaction (optional). The value is case-insensitive but must otherwise match exactly.
Date that the Daily Prep transaction was finalized (optional).
Application User who finalized the transaction (optional). The value is case-insensitive but must otherwise match exactly.
Date that the Daily Prep transaction was canceled (optional).
Application User who canceled the transaction (optional). The value is case-insensitive but must otherwise match exactly.
Application or process that created the Daily Prep transaction (optional). Current possible values: NC (Net-Chef), KS (KitchenSync), MM (Menu Mix) and UN (Undo Menu Mix).
If true, retrieves Daily Prep transactions created by Menu Mix or Undo Menu Mix (optional).
Filters Daily Prep transactions based on whether they include Catering Customer Orders (optional).
Filters Daily Prep transactions based on whether they include additional Projected Consumption (optional).
Retrieve all details (optional).
Specifies the field used to sort the Daily Preps. Default is 'dailyPrepDate' if not provided (Optional).
Specifies the sort direction for Daily Preps: ascending (ASC) or descending (DESC). Default is ASC if not specified (optional).
Specify true to include null data elements in output.
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.
Headers
Secure token for API authentication.
Crunchtime site identifier. (test or production)
User ID for the Crunchtime Application User.
Password for the Crunchtime Application User.
Optional trace identifier for troubleshooting.
Response
Success
Example response
{
"dailyPreps": [
{
"locationCode": "AB121",
"description": "Daily Prep description",
"status": "Incomplete",
"createDate": "11/10/2020",
"createUser": "testuser",
"completeDate": "11/10/2020 07:47:05",
"completeUser": "testuser",
"cancelDate": "11/10/2020 14:24:51",
"cancelUser": "testuser",
"dailyPrepDate": "11/10/2020 13:45",
"templateName": "Morning Prep",
"templateLocationCode": "AB121",
"cateringOrder": "N",
"dailyPrepApp": "NC",
"prepLocation": "Main Kitchen",
"recipes": {
"productNumber": "R-123",
"name": "Test Recipe",
"batchQty": 1.4,
"batchUnit": "KG",
"projectedConsumption": 10.53,
"suggestedProduction": 1,
"actualProd": 23.01,
"actualBatchCost": 63.1,
"storageLocation": "Walk-In Cooler",
"prepStation": "Cold Prep",
"components": {
"productNumber": "C1233",
"name": "Test Component",
"majorIngredient": "Y",
"quantity": 13.5,
"invUnit": "EA",
"storageLocation": "Walk-In Cooler",
"unitPrice": 10.45,
"extendedValue": 121.99
}
}
}
]
}