v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB

Daily Prep Service

getAllDailyPreps

Retrieves all Daily Prep transactions with the accompanying information.

get/dailyprep/v1/getAllDailyPreps

Query parameters

locationCodestring required

The Location where the Daily Prep transaction is created.

dailyPrepDatestring

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.

statusstring

Daily Prep status (Completed, Incomplete or Canceled) to retrieve (optional).

templateNamestring

Template Name selected for the Daily Prep transaction (optional). Required if using Template Location Code.

templateLocationCodestring

Template Location Code selected for the Daily Prep transaction (optional). Required if using Template Name.

prepStationstring

Prep Station Name selected for the Daily Prep transaction (optional). This value is stored in recipe details.

descriptionstring

Daily Prep description (optional). The value is case-insensitive but must otherwise match exactly.

prepLocationstring

Name of the Prep Customer selected for the Daily Prep transaction (optional).

startTimestring

Start time of the Daily Prep transaction as selected when the transaction was created (optional). Format HH:mm (24hr)

createDatestring

Date that the Daily Prep transaction was created (optional).

createUserstring

Application User who created the transaction (optional). The value is case-insensitive but must otherwise match exactly.

completeDatestring

Date that the Daily Prep transaction was finalized (optional).

completeUserstring

Application User who finalized the transaction (optional). The value is case-insensitive but must otherwise match exactly.

cancelDatestring

Date that the Daily Prep transaction was canceled (optional).

cancelUserstring

Application User who canceled the transaction (optional). The value is case-insensitive but must otherwise match exactly.

dailyPrepAppstring

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).

autoPrepFlagboolean

If true, retrieves Daily Prep transactions created by Menu Mix or Undo Menu Mix (optional).

cateringOrderFlagboolean

Filters Daily Prep transactions based on whether they include Catering Customer Orders (optional).

addProjectedConsumptionFlagboolean

Filters Daily Prep transactions based on whether they include additional Projected Consumption (optional).

includeDetailsboolean

Retrieve all details (optional).

Specifies the field used to sort the Daily Preps. Default is 'dailyPrepDate' if not provided (Optional).

sortOrder'ASC' | 'DESC'

Specifies the sort direction for Daily Preps: ascending (ASC) or descending (DESC). Default is ASC if not specified (optional).

includeNullboolean

Specify 'true' to include null data elements in output.

Headers

authenticationtokenstring required

Secure token for API authentication.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring required

User ID for the Crunchtime Application User.

passwordstring required

Password for the Crunchtime Application User.

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Response

Success

locationCodestring

"Location Code" where the Daily Prep transaction is created

descriptionstring

"Description" is entered by the user when the transaction was created. If none was entered, this will be the Daily Prep Date.

statusstring

"Status" of the Daily Prep transaction. Possible values: Completed, Incomplete, or Canceled

createDatestring date

"Create Date" is a date the transaction was created

createUserstring

"Create User" is the user ID of the user who created the transaction

completeDatestring date-time

"Complete Date" is a date with time the transaction was finalized

completeUserstring

"Complete User" is the user ID of the user who finalized the transaction

cancelDatestring date-time

"Cancel Date" is a date with time the transaction was canceled

cancelUserstring

"Cancel User" is the user ID of the user who canceled the transaction

dailyPrepDatestring date-time

"Daily Prep Date" is the date and time when the Daily Prep was performed, as selected by the user during creation

templateNamestring

"Template Name" is the name of the Daily Prep template used for the transaction

templateLocationCodestring

"Template Location Code" is the location code associated with the Daily Prep template

cateringOrderstring

"Catering Order" indicates whether the prep transaction included Catering customer orders

dailyPrepAppstring

"Daily Prep App" is the application or process that created the Daily Prep transaction

prepLocationstring

"Prep Location" is the name of the Prep Customer selected for the Daily Prep transaction

Example response

[
  {
    "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
      }
    }
  }
]