getAllDailyPreps

get

https://webservices-test.net-chef.com/dailyprep/v1/getAllDailyPreps

Retrieves all Daily Prep transactions with the accompanying information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

locationCode

string

required

The Location where the Daily Prep transaction is created.

dailyPrepDate

string

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.

status

string

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

templateName

string

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

templateLocationCode

string

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

prepStation

string

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

description

string

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

prepLocation

string

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

startTime

string

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

createDate

string

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

createUser

string

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

completeDate

string

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

completeUser

string

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

cancelDate

string

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

cancelUser

string

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

dailyPrepApp

string

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

autoPrepFlag

boolean

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

cateringOrderFlag

boolean

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

addProjectedConsumptionFlag

boolean

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

includeDetails

boolean

Defaults to false

Retrieve all details (optional).

sortBy

string

enum

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

sortOrder

string

enum

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

Allowed:

includeNull

boolean

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

Headers

authenticationtoken

string

required

Secure token for API authentication.

sitename

string

required

Crunchtime site identifier. (test or production)

userid

string

required

User ID for the Crunchtime Application User.

password

string

required

Password for the Crunchtime Application User.

X-B3-TraceId

string

Optional trace identifier for troubleshooting.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Success

400Validation Error

401Authorization

404Daily Prep transactions not found

429Too Many Requests

500Unexpected Error

504Timeout