v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB
Recipe Location Service

getAllRecipeLocations

Get All Recipe Locations

get/recipelocation/v1/getAllRecipeLocations

Query parameters

activeFlagboolean

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

atCostItemboolean

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

locationCodestring

The Code that identifies the Location in Crunchtime.

minutesSinceUpdateinteger

The number of minutes since a recipe location record was last updated. Use to set how far back to search. Required if recipeName, productNumber and pluNumber input not provided.

pluNumberinteger

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. Required if recipeName, productNumber and minutesSinceUpdate input not provided.

posDecrementstring

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

prepReportFlagboolean

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

productionTypestring

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

productNumberstring

The Product Number of the Recipe to retrieve. Required if recipeName, pluNumber and minutesSinceUpdate input not provided.

recipeNamestring

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. Required if productNumber, pluNumber and minutesSinceUpdate input not provided.

recipePricenumber

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

includeNullboolean

Specify 'true' to output null data elements.

Headers

authenticationtokenstring required

Secure token for API authentication.

passwordstring required

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring required

"User ID for the Crunchtime Application User.

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Response

Success

Example response

[
  {
    "recipeLocationDetailDetails": [
      {
        "activeFlag": "N",
        "atCostItem": "N",
        "lastTouchDate": "10/12/2022 12:48:36",
        "pluNumber": 10004,
        "posDecrement": "I",
        "prepReportFlag": "Y",
        "productionType": "P",
        "recipeName": "CTest Rcp Location 1",
        "recipePrice": 5.67
      }
    ],
    "recipeLocationHeaderDetails": {
      "pluNumber": 10004,
      "recipeName": "CTest Recipe 1"
    }
  }
]