API Reference

getRecipeLocationsByPage

get
https://webservices-test.net-chef.com/recipelocation/v1/getRecipeLocationsByPage

getRecipeLocationsByPage Implementation Notes

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

This indicates whether or not the recipe is available to each location.

boolean

If yes, the Actual/Theoretical Cost report will display costs for the recipe item (not its components) at the specified location. Analogous field in Recipe API is “calcAtCost”.

string

The Code that identifies the Location in Crunchtime.

int32

The number of minutes since a recipe location record was last updated. Use to set how far back to search.

int32
Defaults to 1

Provide the page number to retrieve Application Users on a particular page. Default is 1 when no 'pageNumber' value provided.

int32

Number of items to display per page.

int64

Retrieve a Recipe's specific PLU Number. The PLU links the recipe to the point-of-sale system and allows ingredients to be depleted from inventory based on sales. This query param will search both the actual pluNumber (header) OR Location plu Number.

string

This determines how quantities will be depleted from inventory when a recipe product is sold.

boolean

This indicates whether or not the recipe is eligible to be included in the Net-Chef Prep Report at this location.

string

This determines whether component ingredients from the location will be used to make this recipe.

string

The Product Number of the Recipe to retrieve.

string

This is the recipe name and can be different names at different locations. Use 3 or more characters. This query param will search both the actual recipe name (header) OR recipe location name.

number

Displays the Ideal Price per Portion from the Recipes…Modeling tab in Enterprise Manager. In the Recipe API the analogous field is called “price”.

boolean

Specify 'true' to output null data elements.

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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json

Updated 5 months ago