---
title: "getRecipesEnhancedByPageV1"
method: GET
path: "/cruise/recipe/v1/getRecipesEnhancedByPage"
tags: ["Recipe Enhanced Service"]
---

# getRecipesEnhancedByPageV1

`GET /cruise/recipe/v1/getRecipesEnhancedByPage`

## Request

- Base URL: `//webservices-test.net-chef.com` (relative, and the document’s source URL is not known)
- URL: `//webservices-test.net-chef.com/cruise/recipe/v1/getRecipesEnhancedByPage`
- Auth: none declared. Required headers: `authenticationtoken`, `password`, `sitename`, `userid`

Retrieve details of a recipe by page number. 

  *Supported from v11.02 and above*.

## Query parameters

- `activeFlag` boolean
- `includeDetails` boolean
- `pageNumber` integer
- `productNumber` string
- `includeNull` boolean

## Headers

- `authenticationtoken` string, required
- `password` string, required
- `sitename` string, required
- `userid` string, required
- `X-B3-TraceId` string

## Response `200`

Success

- RecipeEnhancedBatchResponseDto: RecipeEnhancedBatchResponseDto description
  - `hasNext` boolean
  - `recipeEnhancedDetails` RecipeEnhancedDetails[]
    - `recipeEnhancedAllergenAttributeDetails` RecipeEnhancedAllergenAttributeDetailDto[]
      - `activeFlag` 'N' | 'Y': Product allergen active status.
      - `nutritionClass` string, required: Nutrition Class.
      - `value` string, required: Nutrition Class value.
    - `recipeEnhancedComponentDetails` RecipeEnhancedComponentDetailDto[]
      - `majorIngredient` 'N' | 'Y': Indicates whether component is a main ingredient in the recipe.
      - `name` string: Name of the ingredient.
      - `number` string: Ingredient product number.
      - `preProduction` 'N' | 'Y': "Pre-Production" flag for recipe component
      - `quantity` number, required: Quantity of the ingredient in the recipe.
      - `recipePackage` string: Component Product "Recipe Unit".
      - `scalingFactor` number, required: Component Product "Scale Factor". Must be ≥ 0.00 and ≤ 9.99 with at least 2 decimal places or less.
      - `sequence` number, required: Component Product "Sequence" from recipe.
      - `specialInstruction1` string: Component Product "Special Instruction 1" from recipe
      - `specialInstruction2` string: Component Product "Special Instruction 2" from recipe
    - `recipeEnhancedComponentSubstituteDetails` RecipeEnhancedComponentSubstituteDetailDto[]
      - `componentPackageType` string, required: Original Component "Recipe Unit" from recipe
      - `name` string, required: Original Component "Component Name" from recipe
      - `quantity` number, required: Original Component "Quantity" from recipe
      - `substituteName` string, required: Substitute Component "Component Name" from recipe
      - `substituteNumber` string, required: Substitute Component "Component Product #" from recipe
      - `substitutePackageType` string, required: Substitute Component "Recipe Unit" from recipe
      - `substituteQuantity` number, required: Substitute Component "Component Quantity" from recipe
      - `substituteScaleFactor` number, required: Substitute Component "Scale Factor" from recipe
    - `recipeEnhancedConceptDetails` RecipeEnhancedConceptDetailDto[]
      - `activeFlag` 'N' | 'Y': Concept "Active" flag from recipe
      - `code` string, required: Concept "Code" from recipe
    - `recipeEnhancedHeaderDetails` RecipeEnhancedHeaderDto: RecipeEnhancedHeaderDto description
      - `activeFlag` 'N' | 'Y': Recipe "Active" flag from recipe
      - `allergenAttributes` RecipeEnhancedAllergenAttributeDetailDto[]
        - `activeFlag` 'N' | 'Y': Product allergen active status.
        - `nutritionClass` string, required: Nutrition Class.
        - `value` string, required: Nutrition Class value.
      - `alternateUpcs` RecipeEnhancedUpcDetailDto[]
        - `activeFlag` 'N' | 'Y': Alt UPC "Active" flag from recipe
        - `code` string, required: "Alternate UPC" from recipe
      - `batchPackagePackageType` string, required: "Batch Size" Unit from recipe
      - `batchQuantity` number, required: "Batch Size" Quantity from recipe
      - `batchRoundingBasedOn` 'H' | 'Q' | 'W': "Batch Rounding Based On" setting, from recipe
      - `calcAtCost` 'N' | 'Y': "Calculate Actual/Theoretical Cost for Recipe Item" flag, from recipe
      - `categoryName` string, required: "Category" from recipe
      - `componentSubstitutes` RecipeEnhancedComponentSubstituteDetailDto[]
        - `componentPackageType` string, required: Original Component "Recipe Unit" from recipe
        - `name` string, required: Original Component "Component Name" from recipe
        - `quantity` number, required: Original Component "Quantity" from recipe
        - `substituteName` string, required: Substitute Component "Component Name" from recipe
        - `substituteNumber` string, required: Substitute Component "Component Product #" from recipe
        - `substitutePackageType` string, required: Substitute Component "Recipe Unit" from recipe
        - `substituteQuantity` number, required: Substitute Component "Component Quantity" from recipe
        - `substituteScaleFactor` number, required: Substitute Component "Scale Factor" from recipe
      - `components` RecipeEnhancedComponentDetailDto[]
        - `majorIngredient` 'N' | 'Y': Indicates whether component is a main ingredient in the recipe.
        - `name` string: Name of the ingredient.
        - `number` string: Ingredient product number.
        - `preProduction` 'N' | 'Y': "Pre-Production" flag for recipe component
        - `quantity` number, required: Quantity of the ingredient in the recipe.
        - `recipePackage` string: Component Product "Recipe Unit".
        - `scalingFactor` number, required: Component Product "Scale Factor". Must be ≥ 0.00 and ≤ 9.99 with at least 2 decimal places or less.
        - `sequence` number, required: Component Product "Sequence" from recipe.
        - `specialInstruction1` string: Component Product "Special Instruction 1" from recipe
        - `specialInstruction2` string: Component Product "Special Instruction 2" from recipe
      - `concepts` RecipeEnhancedConceptDetailDto[]
        - `activeFlag` 'N' | 'Y': Concept "Active" flag from recipe
        - `code` string, required: Concept "Code" from recipe
      - `effectiveDate` string, date-time
      - `expirationDate` string, date-time
      - `haccpComplianceName` string: "HACCP Compliance" from recipe
      - `idealCostPercentage` number: "Ideal Cost %" from recipe
      - `inventoryUnitPackageType` string, required: "Portion Yield" Package Type from recipe
      - `issueUnitOnePackageType` string, required: "Issue Unit 1" Package Type from recipe
      - `issueUnitOneYield` number, required: "Issue Unit 1" Quantity from recipe
      - `issueUnitTwoPackageType` string, required: "Issue Unit 2" Package Type from recipe
      - `issueUnitTwoYield` number, required: "Issue Unit 2" Quantity from recipe
      - `lotTracking` 'N' | 'Y': "Lot Tracking" flag from recipe
      - `maxBatchRounding` 'D' | 'N': "Maximum Batch Rounding" setting from recipe
      - `maximumBatch` number: "Maximum Batch" Quantity from recipe
      - `microcategoryName` string: "Microcategory Name" from recipe
      - `minBatchRounding` 'D' | 'L' | 'N' | 'U': "Minimum Batch Rounding" setting from recipe
      - `minMaxBatchRounding` 'D' | 'L' | 'N' | 'U': "Min/Max Batch Rounding" setting from recipe
      - `minimumBatch` number: "Minimum Batch" Quantity from recipe
      - `name` string, required: "Recipe Name" from recipe
      - `number` string, required: "Product Number" from recipe
      - `nutritionConversion` number: "Nutrition Value" from recipe
      - `nutritionId` string: "Nutrition Fact" from recipe
      - `nutritionPackageType` string: "Display Nutrition per" Unit from recipe
      - `platingInstructions` string: "Plating Instructions" from recipe
      - `pluNumber` integer: "PLU Number" from recipe
      - `portionAmount` number, required: "Portion Amount" from recipe
      - `portionYield` number, required: "Portion Yield" Quantity from recipe
      - `prepReportConsRounding` 'D' | 'N' | 'U': "Prep Report Cons. Rounding" setting from recipe
      - `prepReportFlag` 'N' | 'Y': "Include in Prep Report" flag from recipe
      - `prepReportShelfMaxRounding` 'D' | 'N' | 'U': "Prep Report Shelf Life Rounding" setting from recipe
      - `prepStationName` string: "Prep Station" from recipe
      - `prepTimeDuration` number: "Prep Time" Duration from recipe
      - `prepTimeType` 'D' | 'H' | 'M': "Prep Time" Type from recipe
      - `preparationNotes` string: "Prep Instructions" from recipe
      - `price` number: "Recipe Price" from recipe
      - `productionType` 'O' | 'P': "Production Type" setting from recipe
      - `recipeClass` 'I' | 'S': "Recipe Class" from recipe
      - `recipeComplexity` string: "recipeComplexity" from recipe
      - `recipeComplexityLong` integer: "recipeComplexityLong" from recipe
      - `recipePosDecrement` 'C' | 'I': "POS Decrement" setting from recipe
      - `recipeProductGroupName` string: "Recipe Group" from recipe
      - `recipeProductGroupSubname` string: "Recipe Sub-Group" from recipe
      - `recipeRating` string: "recipeRating" from recipe
      - `recipeRatingLong` integer: "recipeRatingLong" from recipe
      - `recipeStatus` 'O' | 'P': Recipe "Status" from recipe
      - `recipeUnitFivePackageType` string: "Recipe Unit 5" Package Type from recipe
      - `recipeUnitFiveYield` number: "Recipe Unit 5" Quantity from recipe
      - `recipeUnitFourPackageType` string: "Recipe Unit 4" Package Type from recipe
      - `recipeUnitFourYield` number: "Recipe Unit 4" Quantity from recipe
      - `recipeUnitOnePackageType` string, required: "Recipe Unit 1" Package Type from recipe
      - `recipeUnitOneYield` number, required: "Recipe Unit 1" Quantity from recipe
      - `recipeUnitThreePackageType` string: "Recipe Unit 3" Package Type from recipe
      - `recipeUnitThreeYield` number: "Recipe Unit 3" Quantity from recipe
      - `recipeUnitTwoPackageType` string: "Recipe Unit 2" Package Type from recipe
      - `recipeUnitTwoYield` number: "Recipe Unit 2" Quantity from recipe
      - `shelfLifeDuration` number: "Shelf Life" Duration from recipe
      - `shelfLifeType` 'D' | 'H' | 'M': "Shelf Life" Type from recipe
      - `shipLocations` RecipeEnhancedShipLocationDetailDto[]
        - `activeFlag` 'N' | 'Y': Ship Location "Active" flag from recipe
        - `locationName` string, required: "Ship Location" from recipe
      - `storageContainerPackage` string: "Default Storage Container" Package from recipe
      - `subcategoryName` string: "Subcategory" from recipe
      - `universalProductCode` string: "Universal Product Code" from recipe
    - `recipeEnhancedShipLocationDetails` RecipeEnhancedShipLocationDetailDto[]
      - `activeFlag` 'N' | 'Y': Ship Location "Active" flag from recipe
      - `locationName` string, required: "Ship Location" from recipe
    - `recipeEnhancedUpcDetails` RecipeEnhancedUpcDetailDto[]
      - `activeFlag` 'N' | 'Y': Alt UPC "Active" flag from recipe
      - `code` string, required: "Alternate UPC" from recipe
  - `totalPages` integer

## Other responses

- `400`: Validation Error
- `401`: Authorization
- `404`: Recipe not found
- `500`: Unexpected Error
- `504`: Timeout

---

[API](https://skmtc.dev/crunchtime/apis/cruise-platform.md) - [All operations](https://skmtc.dev/crunchtime/apis/cruise-platform/llms.txt) - [OpenAPI document](https://skmtc.dev/crunchtime/apis/cruise-platform/revisions/d6bb0437a907?raw)