Skip to content

Inventory Recipes ​

Recipes define how inventory items are combined to produce articles or other items.

Storage Location ​

{customer_id}-recipe.json

Fields ​

FieldTypeRequiredDescription
idnumberYesv1.3. Recipe id.
customer_idnumberYesv1.3. Customer id.
article_idnumberNov1.3. Article the recipe belongs to.
article_namestringNov1.3. Article name (denormalized).
produced_item_idnumberNov1.3. Item produced by the recipe.
ingredientsarrayNov1.3. Array of {"item_id": <number>, "item_name": <string>, "quantity": <number>} — quantity in the ingredient item's base unit.

Example ​

json
[
  {
    "id": 301,
    "customer_id": 10352,
    "article_id": 584758,
    "article_name": "Latte",
    "produced_item_id": null,
    "ingredients": [
      {
        "item_id": 45101,
        "item_name": "Espresso Beans",
        "quantity": 18
      },
      {
        "item_id": 45102,
        "item_name": "Whole Milk",
        "quantity": 300
      },
      {
        "item_id": 45103,
        "item_name": "Milk Foam",
        "quantity": 50
      }
    ]
  },
  {
    "id": 302,
    "customer_id": 10352,
    "article_id": 584734,
    "article_name": "Kanelsnurr",
    "produced_item_id": null,
    "ingredients": [
      {
        "item_id": 45201,
        "item_name": "Flour",
        "quantity": 250
      },
      {
        "item_id": 45202,
        "item_name": "Cinnamon",
        "quantity": 5
      },
      {
        "item_id": 45203,
        "item_name": "Sugar",
        "quantity": 80
      }
    ]
  }
]
  • Customers - Parent customer/tenant
  • Articles - Articles that use recipes
  • Items - Inventory items used as ingredients

Technical documentation for partners and integrators