Calculate BOM for Single Recipe

Calculate the Bill of Materials for a single recipe.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Calculate what ingredients you need to order for a given recipe and outlet. The response includes needed quantities, current stock levels, outstanding orders, and supplier package options with pricing.

Requires the procurement scope and the Ordering module.

Quantity fields

Unrequested quantities return null. For example, if consider_stock is false, the in_stock_quantity fields will be null.

Currency

No currency is included in the response. Use GET /library_settings/default_currency/ to get the library's currency.

Supplier packages

Supplier packages are sorted with the cheapest and last-ordered packages first. Use cheapest_package_id and last_ordered_package_id at the ingredient level for efficient lookup.

Path Params
string
required

The ID of the recipe.

Body Params
integer
required

The ID of the outlet.

number
required

Number of servings to calculate for.

boolean
required

Whether to subtract current stock from the needed quantity.

boolean
required

Whether to subtract outstanding purchase orders from the needed quantity.

Responses

400

Invalid request body.

403

User lacks permission.

404

Recipe or outlet not found, or belongs to a different library.

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json