Skip to content

Recipe Builder

The Recipe Builder is a powerful tool that allows you to create and customize recipes by adding ingredients, adjusting quantities, and setting various recipe attributes. It provides an intuitive interface for managing your recipes and integrating them into your inventory system.

The Recipe Builder enables you to:

  • Create New Recipes: Define new recipes with ingredients, quantities, and other attributes.
  • Edit Existing Recipes: Modify recipe details and ingredients.
  • Manage Sub-Recipes: Use recipes as components in other recipes.
  • Customize Recipe Settings: Set options like location, category, and override behaviors.


Ingredients Management

  • Add Ingredients: Select inventory items or existing ignredients to use as ingredients.
  • Ingredient Details: Specify unit of measure, quantity, additional price, inclusion level, and quantity constraints.
  • Ingredient Categories: Organize ingredients into categories, which can be exclusive or non-exclusive.

Sub-Recipes

  • Apply Sub-Recipes: Integrate existing sub-recipes into the current recipe.
  • Preview Sub-Recipes: View the details of sub-recipes directly from the builder.

Creating a New Recipe

To create a new recipe, follow these steps:

  1. Access the Recipe Builder: From the Recipe Dashboard, click the Create Recipe button.

  2. Enter Recipe Details:

    • Recipe Name: Enter a unique name for your recipe.

    • Category:

      • Click on the Category dropdown to select an existing category.
      • In the popover, you can select from the list of existing categories. To add a new category, use the Recipe Dashboard page
    • Use as Sub-Recipe:

      • Toggle the Use as Sub-Recipe switch to On if this recipe will be used as a component in other recipes. This allows the recipe to act as a 'roll-up' recipe within larger recipes.
    • Override Missing Ingredients:

      • Toggle the Override Missing Ingredients switch to On if you want to enable the sale of this recipe even when stock levels are below zero. This is useful in scenarios where you have physical stock available but the system inventory hasn't been updated accurately.
  3. Add Ingredients:

    • Click on the + Add button in the Ingredients section.
    • For each ingredient:
      • Select Ingredient:
        • Click on the ingredient field to open the selection popover.
        • Choose between Ingredients (sub-recipes) or Inventory items using the tabs.
        • Use the search bar to find the desired ingredient or inventory item.
        • Click on an item to select it.
      • Unit of Measure:
        • Click on the Unit of Measure dropdown and select the appropriate unit.
      • Quantity:
        • Enter the quantity required for the recipe.
      • Additional Price (Optional):
        • Enter any additional cost associated with the ingredient.
      • Inclusion Level:
        • Click on the Inclusion dropdown to select the inclusion level (e.g., Mandatory, Optional).
      • Minimum and Maximum Quantity (Optional):
        • Specify any quantity constraints for the ingredient.
      • Ingredient Category:
        • Click on the Category field to assign or create a category for the ingredient.
        • Categories help organize ingredients and can be set as exclusive.
  4. Manage Sub-Recipes (Optional):

    • Navigate to the Sub Recipes tab.
    • Apply Sub-Recipes:
      • Toggle on the sub-recipes you want to include in your recipe.
    • Preview Sub-Recipes:
      • Click the preview icon to view details of a sub-recipe.
  5. Save Recipe:

    • Once all details are entered, click the Save Recipe button.
    • The recipe will be saved and available in the Recipe Dashboard.

Editing an Existing Recipe

To edit an existing recipe:

  1. Open the Recipe:

    • From the Recipe Dashboard, locate the recipe you wish to edit.
    • Click the edit icon next to the recipe.
  2. Modify Recipe Details:

    • Update the Recipe Name, Category, Location, Use as Sub-Recipe, and Override Missing Ingredients settings as needed.
  3. Edit Ingredients:

    • Add Ingredients: Use the + Add button to include new ingredients.
    • Modify Ingredients:
      • Adjust quantities, units of measure, additional prices, inclusion levels, and categories.
      • Click on fields to make changes, such as changing the unit of measure or updating the quantity.
    • Remove Ingredients:
      • Click the delete icon to remove an ingredient from the recipe.
  4. Manage Sub-Recipes:

    • Switch to the Sub Recipes tab to apply or remove sub-recipes.
    • Toggle the Apply Sub Recipe switch to include or exclude sub-recipes.
  5. Save Changes:

    • Click the Save Recipe button to save your changes.

Using the Ingredient Selection Popover

When adding or editing an ingredient, you can select from existing ingredients or inventory items.

Steps to Select an Ingredient:

  1. Open Selection Popover:

    • Click on the ingredient name field to open the selection popover.
  2. Choose Ingredient or Inventory:

    • Use the tabs to switch between Ingredients and Inventory Items.
  3. Search and Select:

    • Use the search bar to find specific items.
    • Click on an item to select it as an ingredient.
  4. Assign Details:

    • After selection, proceed to assign unit of measure, quantity, and other details.


  • Recipe Tab: Manage the ingredients of the recipe.
  • Sub Recipes Tab: Apply existing sub-recipes to your current recipe.
  • Switching Tabs: Click on the tab names to switch between Recipe and Sub Recipes.

Previewing Sub-Recipes

You can preview the details of sub-recipes directly from the Recipe Builder.

Steps to Preview a Sub-Recipe:

  1. Navigate to Sub Recipes Tab:

    • Click on the Sub Recipes tab in the Recipe Builder.
  2. Locate the Sub-Recipe:

    • Find the sub-recipe you wish to preview.
  3. Click the Preview Icon:

    • Click the preview icon next to the sub-recipe.
    • A modal will open displaying the sub-recipe details, including ingredients and configurations.
  4. Close the Preview:

    • Click the Close button to exit the preview.

To return to the Recipe Dashboard or navigate between pages:

  • Recipe Dashboard: Click on the Recipe Dashboard breadcrumb at the top of the page.
  • Breadcrumb Navigation: Use the breadcrumbs to keep track of your current location and navigate between sections.