Pick ingredients from a package
Choose which ingredients of a catalog package show in the user's ingredient picker (and so can be used in recipes, stock and orders). select: "all" adds the whole package (ingredients the supplier adds later included); select: "none" removes all of it; add / remove change single ingredients (ids or exact names within that package, from get_ingredient_packages or find_ingredients; when several packages offer the same ingredient, pick by id). Removing only hides ingredients from the picker: recipes and stock keep their copies. The user's own packages (My Ingredients, imports) are always fully picked. Scope: `inventory:write` (or `write`).
Choose which ingredients of a catalog package show in the user's ingredient picker (and so can be used in recipes, stock and orders). select: "all" adds the whole package (ingredients the supplier adds later included); select: "none" removes all of it; add / remove change single ingredients (ids or exact names within that package, from get_ingredient_packages or find_ingredients; when several packages offer the same ingredient, pick by id). Removing only hides ingredients from the picker: recipes and stock keep their copies. The user's own packages (My Ingredients, imports) are always fully picked.
Scope: inventory:write (or write).
API token in format: bfk_. Each operation lists the token scope it requires (the scopes are listed below).
read: Read everything (all areas)write: Create, change and delete everything (all areas)brews:read: List and view brewsbrews:write: Create, update, delete brews and notesinventory:read: List inventory itemsinventory:write: Create, update, delete inventory itemsequipment:read: List equipment profilesequipment:write: Create, update, delete equipment profilesstyles:read: List style profilesstyles:write: Create, update, delete style profilesprofiles:read: List mash, fermentation, and water profilescustom-fields:read: List custom field definitionscustom-fields:write: Create, update, delete custom field definitionsprofiles:write: Create, update, delete mash, fermentation, and water profilescellar:read: View cellar, packaged stock, tap lists, and labelscellar:write: Manage cellar, packaging, stock, tap lists, and labelssettings:read: View preferences, imports, calculators, and your data exportsettings:write: Change preferences and undo importscommunity:read: View community, feedback, tickets, inbox, and account overviewcommunity:write: Post, vote, and reply in community, feedback, and tickets
In: header
Scope: inventory:write
Request Body
application/json
The ingredient package: its id or exact name (e.g. "Weyermann", "Yakima Chief Hops"). get_ingredient_packages lists them.
"all": the whole package; "none": nothing from it. Can be combined with add/remove, which apply after it.
"all" | "none"Ingredients of this package to add to the picker: ids or exact names, e.g. ["Citra", "Mosaic"].
items <= 200Ingredients of this package to take out of the picker: ids or exact names.
items <= 200Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://brewforge.sh/api/v1/actions/select_package_ingredients" \ -H "Content-Type: application/json" \ -d '{ "package": "string" }'{
"package": {
"id": "string",
"name": "string"
},
"selected": 0,
"total": 0,
"whole_package": true,
"added": [
{
"id": "string",
"name": "string"
}
],
"removed": [
{
"id": "string",
"name": "string"
}
]
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}