CRcrunchtime
Recipe Enhanced Service

saveRecipesV2

Changed on

Create a new recipe. Update a recipe.

post/recipe/v2/saveRecipesEnhanced

Request

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

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.

Request body

locationCodestring required

The Code that identifies the Location in Crunchtime.

Example request

{
  "locationCode": "000000",
  "recipeEnhancedDetails": [
    {
      "recipeEnhancedAllergenAttributeDetails": [
        {
          "activeFlag": "Y",
          "nutritionClass": "nutritionClass",
          "value": "value"
        }
      ],
      "recipeEnhancedComponentDetails": [
        {
          "majorIngredient": "Y",
          "name": "Component Product Name",
          "number": "Component Product Number",
          "preProduction": "Y",
          "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",
        "effectiveDate": "20240305",
        "expirationDate": "20240307",
        "haccpComplianceName": "Keep frozen",
        "idealCostPercentage": 5,
        "inventoryUnitPackageType": "EA",
        "issueUnitOnePackageType": "LB",
        "issueUnitOneYield": 6,
        "issueUnitTwoPackageType": "CASE",
        "issueUnitTwoYield": 6,
        "lotTracking": "N",
        "maxBatchRounding": "N",
        "maximumBatch": 5,
        "microcategoryName": "BAKERY",
        "minBatchRounding": "L",
        "minMaxBatchRounding": "N",
        "minimumBatch": 2,
        "name": "Chicken Salad",
        "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": 5,
        "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": 2,
        "shelfLifeDuration": 3,
        "shelfLifeType": "D",
        "storageContainerPackage": "ML",
        "subcategoryName": "BAKERY"
      },
      "recipeEnhancedShipLocationDetails": [
        {
          "activeFlag": "Y",
          "locationName": "Ship Location"
        }
      ],
      "recipeEnhancedUpcDetails": [
        {
          "activeFlag": "Y",
          "code": "Alternate UPC"
        }
      ]
    }
  ]
}

Response

Success

object required

Changes

  • fff247a87cc9Revision changes
    • breaking

      the request property //// became required

    • breaking

      the request property //// became required

    • breaking

      the /// request property format changed from no format to date

    • breaking

      the /// request property format changed from no format to date

    • info

      the response property //// became required for the status (media type: */*)

    • info

      the response property //// became required for the status (media type: application/json)

    • info

      the response property //// became required for the status (media type: */*)

    • info

      the response property //// became required for the status (media type: application/json)