Package beer into kegs, bottles or cans
Records packaging day: beer from a brew (its tank, or straight from the brew) or from a vessel goes into kegs (litres each) and bottles/cans (counts), with loss in litres. Example: 'kegged the pale ale today: 19 L into Corny 1, 6 bottles of 0.5 L, half a litre lost' → {"brew":"Pale Ale","kegs":[{"keg":"Corny 1","volume_l":19}],"containers":[{"container":"0.5 L bottles","count":6}],"loss_l":0.5}. Call get_packaging_context first to see the litres available, the free kegs and the container names. Each keg becomes a serving stay holding its litres; bottles/cans add to stock; the source tank is emptied (source_empty) and the brew gets its packaging date. If packaged litres plus loss do not match what is available it still packages, and warnings says so (tell the user; pass available_l when the tank held more than shown). An overfilled keg is refused. Needs the plan feature `cellar`. Scope: `cellar:write` (or `write`).
Records packaging day: beer from a brew (its tank, or straight from the brew) or from a vessel goes into kegs (litres each) and bottles/cans (counts), with loss in litres. Example: 'kegged the pale ale today: 19 L into Corny 1, 6 bottles of 0.5 L, half a litre lost' → {"brew":"Pale Ale","kegs":[{"keg":"Corny 1","volume_l":19}],"containers":[{"container":"0.5 L bottles","count":6}],"loss_l":0.5}. Call get_packaging_context first to see the litres available, the free kegs and the container names. Each keg becomes a serving stay holding its litres; bottles/cans add to stock; the source tank is emptied (source_empty) and the brew gets its packaging date. If packaged litres plus loss do not match what is available it still packages, and warnings says so (tell the user; pass available_l when the tank held more than shown). An overfilled keg is refused.
Needs the plan feature cellar. Scope: cellar: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: cellar:write
Request Body
application/json
Package this brew (from the tank it is in, or straight from the brew if it is in no vessel). The brew: its id, its batch number (e.g. 12 or "#12") or its exact name (e.g. "Citra Pale Ale"). Case does not matter.
Instead of brew: the vessel (or stay id) the beer comes out of, e.g. "Brite tank" or a keg "Corny 2" to move beer from a keg into bottles.
Kegs filled; each keg once.
items <= 50Bottles/cans filled, by container type.
items <= 50Litres lost (trub, spills, left in lines), e.g. 0.5. Default 0.
0 <= valueLitres actually in the source, when get_packaging_context showed estimate: true or no volume. Ignored when the tank has a measured volume.
0 <= valuetrue = the source is empty afterwards (tank stay ends). Default: true for a tank or brew, false when repackaging from a keg (kegs are ended with end_stay).
The brewer's local date today, YYYY-MM-DD (e.g. "2026-11-11"). Optional: defaults to today in UTC. Pass it when the brewer's day differs from UTC (late evening in America, early morning in Asia).
^\d{4}-\d{2}-\d{2}$Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://brewforge.sh/api/v1/actions/package_beer" \ -H "Content-Type: application/json" \ -d '{}'{
"packaged": true,
"beer": "string",
"changes": [
"string"
],
"source_free_from": "string",
"warnings": [
"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": {}
}
}