v1

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

getRecipesEnhancedByPageV2

Retrieve details of a recipe by page number.

get/recipe/v2/getRecipesEnhancedByPage

Query parameters

activeFlagboolean

Use true to retrieve only active Recipes.

categorystring

Retrieve recipes linked to a particular Category. (optional)

componentDetailsboolean

Retrieve the details of a Recipe Component. (optional)

includeDetailsboolean

Use true to retrieve detailed information each Recipe (optional).

microCategorystring

Retrieve recipes linked to a particular Micro Category. (optional)

minutesSinceUpdateinteger

The number of minutes since a recipe record was last updated. Use to set how far back to search, Must be more than 0 and less than 43200 (30 days). (optional)

pageNumberinteger

Retrieve one or more records by pageNumber. Use to retrieve data in smaller chunks. If left blank, the default is 1.

pluNumberinteger

Retrieve recipe with a specific PLU Number. (optional)

productNumberstring

The Product Number of the Recipe to retrieve.

recipeNamestring

Retrieve recipes matching a Recipe Name. Use 3 or more characters. (optional)

subCategorystring

Retrieve recipes linked to a particular Sub-Category. (optional)

universalProductCodestring

Retrieve recipes with a particular Product Code. (optional)

pageSizeinteger

Number of items to display per page.

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

hasNextboolean
totalPagesinteger

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",
        "batchPackagePackageType": "GAL",
        "batchQuantity": 1,
        "batchRoundingBasedOn": "W",
        "calcAtCost": "N",
        "categoryName": "FOOD",
        "haccpComplianceName": "Keep frozen",
        "idealCostPercentage": 5,
        "inventoryUnitPackageType": "EA",
        "issueUnitOnePackageType": "LB",
        "issueUnitOneYield": 6,
        "issueUnitTwoPackageType": "CASE",
        "issueUnitTwoYield": 6,
        "lastTouchDate": "04/22/2024",
        "lotTracking": "N",
        "maxBatchRounding": "N",
        "maximumBatch": 5,
        "microcategoryName": "BAKERY",
        "minBatchRounding": "L",
        "minMaxBatchRounding": "N",
        "minimumBatch": 2,
        "name": "Sonar Recipe_test1",
        "number": "R-14366",
        "nutritionConversion": 10,
        "nutritionPackageType": "LB",
        "platingInstructions": "Serve on oval plate.",
        "pluNumber": 74205,
        "portionAmount": 1,
        "portionYield": 1,
        "prepReportConsRounding": "U",
        "prepReportFlag": "N",
        "prepReportShelfMaxRounding": "D",
        "prepStationName": "Prep Station 1",
        "prepTimeDuration": 0.01,
        "prepTimeType": "M",
        "preparationNotes": "Cook burger to desired temp.",
        "price": 6,
        "productionType": "P",
        "recipeClass": "S",
        "recipeComplexityLong": 9999,
        "recipePosDecrement": "C",
        "recipeProductGroupName": "Appetizer",
        "recipeProductGroupSubname": "Appetizer Sub-Grou",
        "recipeRatingLong": 9999,
        "recipeStatus": "P",
        "recipeUnitFivePackageType": "OZ",
        "recipeUnitFiveYield": 5,
        "recipeUnitFourPackageType": "CUP",
        "recipeUnitFourYield": 4,
        "recipeUnitOnePackageType": "GAL",
        "recipeUnitOneYield": 6,
        "recipeUnitThreePackageType": "QUART",
        "recipeUnitThreeYield": 2,
        "recipeUnitTwoPackageType": "HALF GAL",
        "recipeUnitTwoYield": 1,
        "shelfLifeDuration": 3,
        "shelfLifeType": "D",
        "storageContainerPackage": "ML",
        "subcategoryName": "BAKERY"
      },
      "recipeEnhancedShipLocationDetails": [
        {
          "activeFlag": "N",
          "locationName": "Ship Location"
        }
      ],
      "recipeEnhancedUpcDetails": [
        {
          "activeFlag": "Y",
          "code": "32323232_test11"
        }
      ]
    }
  ]
}