Recipe Enhanced Service
getRecipesEnhancedByPageV1
Retrieve details of a recipe by page number.
Supported from v11.02 and above.
get/cruise/recipe/v1/getRecipesEnhancedByPage
Query parameters
activeFlagboolean
Use true to retrieve only active Recipes.
includeDetailsboolean
Use true to retrieve detailed information for one Recipe at a time (optional). When true, productNumber must be used.
pageNumberinteger
Retrieve one or more records by pageNumber. Use to retrieve data in smaller chunks. If left blank, the default is 1.
productNumberstring
The Product Number of the Recipe to retrieve.
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
{
"recipeEnhancedDetails": [
{
"recipeEnhancedAllergenAttributeDetails": [
{
"activeFlag": "Y",
"nutritionClass": "nutritionClass",
"value": "value"
}
],
"recipeEnhancedComponentDetails": [
{
"majorIngredient": "Y",
"name": "Component Product Name",
"number": "Component Product Number",
"preProduction": "N",
"quantity": 9999.9999,
"recipePackage": "Component Product Recipe Package",
"scalingFactor": 9999.9999,
"sequence": 9999.9999,
"specialInstruction1": "Component Product Special Instruction 1",
"specialInstruction2": "Component Product Special Instruction 2"
}
],
"recipeEnhancedComponentSubstituteDetails": [
{
"componentPackageType": "Component Product Recipe Package",
"name": "Component Product Name",
"quantity": 9999.9999,
"substituteName": "Substitute Component Product Name",
"substituteNumber": "Substitute Component Product Number",
"substitutePackageType": "Substitute Component Product Recipe Package",
"substituteQuantity": 9999.9999,
"substituteScaleFactor": 9999.9999
}
],
"recipeEnhancedConceptDetails": [
{
"activeFlag": "Y",
"code": "Enb001"
}
],
"recipeEnhancedHeaderDetails": {
"activeFlag": "Y",
"allergenAttributes": [
{
"activeFlag": "Y",
"nutritionClass": "nutritionClass",
"value": "value"
}
],
"alternateUpcs": [
{
"activeFlag": "Y",
"code": "32323232_test11"
}
],
"batchPackagePackageType": "batchPackagePackageType",
"batchQuantity": 9999.9999,
"batchRoundingBasedOn": "W",
"calcAtCost": "Y",
"categoryName": "categoryName",
"componentSubstitutes": [
{
"componentPackageType": "Component Product Recipe Package",
"name": "Component Product Name",
"quantity": 9999.9999,
"substituteName": "Substitute Component Product Name",
"substituteNumber": "Substitute Component Product Number",
"substitutePackageType": "Substitute Component Product Recipe Package",
"substituteQuantity": 9999.9999,
"substituteScaleFactor": 9999.9999
}
],
"components": [
{
"majorIngredient": "Y",
"name": "Component Product Name",
"number": "Component Product Number",
"preProduction": "N",
"quantity": 9999.9999,
"recipePackage": "Component Product Recipe Package",
"scalingFactor": 9999.9999,
"sequence": 9999.9999,
"specialInstruction1": "Component Product Special Instruction 1",
"specialInstruction2": "Component Product Special Instruction 2"
}
],
"concepts": [
{
"activeFlag": "Y",
"code": "Enb001"
}
],
"haccpComplianceName": "haccpComplianceName",
"idealCostPercentage": 9999.9999,
"inventoryUnitPackageType": "inventoryUnitPackageType",
"issueUnitOnePackageType": "issueUnitOnePackageType",
"issueUnitOneYield": 9999.9999,
"issueUnitTwoPackageType": "issueUnitTwoPackageType",
"issueUnitTwoYield": 9999.9999,
"lotTracking": "Y",
"maxBatchRounding": "D",
"maximumBatch": 9999.9999,
"microcategoryName": "microcategoryName",
"minBatchRounding": "L",
"minMaxBatchRounding": "L",
"minimumBatch": 9999.9999,
"name": "Recipe Name",
"number": "Product Number",
"nutritionConversion": 9999.9999,
"nutritionId": "nutritionId",
"nutritionPackageType": "INVENTORY",
"platingInstructions": "preparationNotes",
"portionAmount": 9999.9999,
"portionYield": 9999.9999,
"prepReportConsRounding": "U",
"prepReportFlag": "Y",
"prepReportShelfMaxRounding": "U",
"prepStationName": "prepStationName",
"prepTimeDuration": 9999.9999,
"prepTimeType": "D",
"preparationNotes": "preparationNotes",
"price": 9999.9999,
"productionType": "P",
"recipeClass": "S",
"recipeComplexityLong": 9999,
"recipePosDecrement": "C",
"recipeProductGroupName": "recipeProductGroupName",
"recipeProductGroupSubname": "recipeProductGroupSubname",
"recipeRatingLong": 9999,
"recipeStatus": "O",
"recipeUnitFivePackageType": "recipeUnitFivePackageType",
"recipeUnitFiveYield": 9999.9999,
"recipeUnitFourPackageType": "recipeUnitFourPackageType",
"recipeUnitFourYield": 9999.9999,
"recipeUnitOnePackageType": "recipeUnitOnePackageType",
"recipeUnitOneYield": 9999.9999,
"recipeUnitThreePackageType": "recipeUnitThreePackageType",
"recipeUnitThreeYield": 9999.9999,
"recipeUnitTwoPackageType": "recipeUnitTwoPackageType",
"recipeUnitTwoYield": 9999.9999,
"shelfLifeDuration": 9999.9999,
"shelfLifeType": "D",
"shipLocations": [
{
"activeFlag": "N",
"locationName": "Ship Location"
}
],
"storageContainerPackage": "storageContainerPackage",
"subcategoryName": "subcategoryName",
"universalProductCode": "UPC"
},
"recipeEnhancedShipLocationDetails": [
{
"activeFlag": "N",
"locationName": "Ship Location"
}
],
"recipeEnhancedUpcDetails": [
{
"activeFlag": "Y",
"code": "32323232_test11"
}
]
}
]
}