Plan one room with BuildBatch (every option)
plan_roomRead-onlyIdempotent
Works out the whole shopping list for one room, with every option the planner has: exact door and window sizes, a product's own coverage and pack sizes, an L-shaped room, tiling part-way up a wall. Arguments are the named parameters of /plan.json. A job is required. Repeated door, window and opening values are arrays. No price is used; price arguments are ignored and named in the answer. Returns a short shopping list: each item with its quantity and reason, and a link to the whole list.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| job | Yes | The job. Required. wallpaper is the paint job with papered walls and no ceiling; tiles is the paint job with tiled walls and no ceiling; both is paint and a new floor; paint-carpet is paint and carpet from a roll; skirting is skirting and architrave. | |
| area | No | Loft insulation, concrete and a patio only: the floor's area in square metres, up to 900, instead of length and width. How far it is round is then not known: the formwork or the edging is a check without a length. | |
| bath | No | A bath or shower tray: a name (bath-1700, tray-900) or its length along the wall x its rim height x how far it comes into the room, in the units. The wall behind it comes off up to the rim, and its footprint off a floor being laid. The key may be repeated. | |
| door | No | One per door, the value repeated for more. A typical size by name (int-762 is a standard internal door) or width x height in the units. *2 after it means two the same. | |
| have | No | Line ids, comma separated, to mark Already have before the list is made. The ids are in the answer's lines. Rarely needed. | |
| loft | No | Whether the loft insulation uses labelled example figures (quick) or figures measured in the loft and read from the chosen roll (custom). Needed for the keys below to take effect. | |
| name | No | What the room is called. Optional. It is carried into the links the answer gives, where the person can also add it themselves. | |
| need | No | Line ids, comma separated, to mark Need before the list is made. The ids are in the answer's lines. Rarely needed. | |
| plan | No | A room that is not a rectangle: its corners in turn, in metres whatever units says, as x,y pairs separated by ";". Replaces length and width. Up to 24 corners. | |
| trim | No | New skirting, architrave or both (skirting,architrave), with any job in a room; a loft floor, a slab and a patio take none. Default skirting for the skirting job, else none. | |
| board | No | Whether the plasterboard uses labelled example figures (quick) or figures from the board and system specification (custom). Needed for the keys below to take effect. | |
| check | No | Line ids, comma separated, to mark Check first before the list is made. The ids are in the answer's lines. Rarely needed. | |
| floor | No | Whether the flooring uses the labelled example figures (quick) or figures read off the pack (custom). Needed for the keys below to take effect. | |
| paper | No | Whether the wallpaper is the labelled example roll (quick) or read off the label (custom). Needed for the keys below to take effect. | |
| patio | No | Whether the patio uses labelled example figures (quick: a 600 × 600 mm slab, the makers' 10 mm joint, 10% for cuts, a 30 mm bed at 1 : 4) or figures entered from the slab and the guides (custom). Needed for the keys below to take effect. The room is the patio: its length and width, no height. | |
| units | No | What length, width, height and the doors are measured in. Default m. In ft write 13ft9in, or 13 for whole feet. | |
| walls | No | What the walls get. The job sets it, so it is rarely needed: paint, wallpaper, tiles, board or none. | |
| width | No | The other side of the floor, in the units. Not needed when plan is given. | |
| carpet | No | Whether the carpet uses the labelled example roll figures (quick) or figures from the carpet and shop (custom). Needed for the keys below to take effect. | |
| detail | No | How much to return. summary, the default: each item with its quantity and reason, what to check first and the list link. full: every line's working, pack breakdown and each shop's search link as well (20 KB or more). | |
| ground | No | Whether the floor is on the ground floor. Default unsure. Used by flooring jobs. | |
| height | No | Floor to ceiling, in the units. Needed when walls are painted, papered, tiled or boarded (paint-carpet too); not for flooring, carpet, loft insulation, concrete or skirting alone. | |
| length | No | One side of the floor, in the units. A length may carry its own unit (360cm, 4200mm). Not needed when plan is given. | |
| window | No | One per window, the value repeated for more. A typical size by name (win-standard) or width x height in the units. *2 after it means two the same. | |
| ceiling | No | What the ceiling gets: paint, or board on the plasterboard job, or none. Another word is named in ignored[] and the job's own choice used. | |
| fitting | No | How the floor is fitted. Default unsure. Used by flooring jobs. | |
| lengths | No | Whether the skirting and architrave lengths are the labelled examples (quick) or the lengths the shop sells (custom). Needed for the keys below to take effect. | |
| opening | No | Any other opening to take off the walls (a garage door, an archway), as width x height or a name. The key may be repeated. | |
| surface | No | What the painted surfaces are like now. Default sound, the planner's own default. Used by painting jobs. | |
| concrete | No | Whether the concrete slab uses labelled example figures (quick) or the thickness decided for the job and figures read off the bag (custom). Needed for the keys below to take effect. The room is the slab: its length and width, no height. | |
| subfloor | No | What is under a new floor. Default unsure. Used by flooring jobs. | |
| woodwork | No | Paint jobs only: paint when the woodwork is painted too (this room's doors, their architraves, the windows' frames and the skirting, counted from the doors and windows given and the room's perimeter, in satinwood at a typical coverage). With walls=none and ceiling=none, the woodwork on its own. Left out: not painted. | |
| loft.over | No | Thickness in millimetres of a second roll laid across the joists over one layer of the first; optional. With it, the first roll is one layer between the joists and the rest is this roll. | |
| loft.pack | No | Square metres covered by one chosen roll or pack; optional for a 100, 150, 170 or 200 mm roll, whose typical coverage (the maker's, as the shops' feeds name it) is used and said so. | |
| patio.bag | No | What one bag of cement fills in litres, from the bag; optional. Without it the bags are counted from a typical 17 L a 25 kg bag, said to be typical. | |
| patio.bed | No | Depth of the full mortar bed in millimetres, before tamping. The makers' guides give 30 to 40 mm. | |
| wallpaint | No | Whether the wall paint uses the labelled example figures (quick) or figures read off the tin (custom). Needed for the keys below to take effect. | |
| walltiles | No | Whether the wall tiles are the labelled example box (quick) or read off the box (custom). Needed for the keys below to take effect. | |
| woodpaint | No | Whether the woodwork paint (with woodwork=paint) uses the labelled example figures (quick) or figures read off the tin (custom). Needed for the keys below to take effect. | |
| board.skim | No | Metres squared one bag of finish plaster covers, from the bag. | |
| loft.depth | No | Thickness of one new mineral-wool layer in millimetres, from the chosen roll. | |
| loft.extra | No | Percent to add for cuts and fitting. | |
| newplaster | No | Painting jobs: is any of it new or bare plaster? yes adds a mist coat of white contract matt on its own line and leaves the sugar soap out; no is a sound painted surface. Left out, the list is a sound room's and its primer line carries the question to ask. | |
| not-needed | No | Line ids, comma separated, to mark Not needed before the list is made. The ids are in the answer's lines. Rarely needed. | |
| patio.bags | No | How the sand and the sub-base are bought: bulk (bulk bags of about 800 kg) or bags (25 kg bags). Bulk unless given; each is counted in whole bags from a typical figure that names its source. | |
| patio.pack | No | How many slabs a pack holds, a whole number; optional. With it, whole packs are counted. | |
| patio.sand | No | Parts of sharp sand in the bed, by volume. The guides give 3 or 4 to 1 of cement. | |
| board.extra | No | Percent to add for cuts. Custom only: with quick the example is used, and a figure sent here is named in ignored[] as not used. | |
| board.width | No | Board width in metres. Custom only: with quick the example is used, and a figure sent here is named in ignored[] as not used. | |
| carpet.step | No | The step in metres in which the shop sells the cut length. | |
| floor.depth | No | Floor tiles: the tile's thickness in millimetres, for the grout. Left out, a typical 10 mm is used and said so. | |
| floor.extra | No | Percent to add for cuts. With quick, a figure sent here is used and labelled as the person's; the ones not sent stay the labelled examples. | |
| floor.grout | No | Floor tiles: metres squared one bag of grout covers. | |
| floor.joint | No | Floor tiles: the joint width in millimetres. With the tile size, the grout is counted by the makers' rule; left out, a typical 3 mm joint is used and said so. | |
| floor.packs | No | Metres squared in one pack or box, comma separated for several sizes. A size may carry a price after "@": the price is accepted and ignored. With quick, a figure sent here is used and labelled as the person's; the ones not sent stay the labelled examples. | |
| floor.tileh | No | Floor tiles: the other side of a tile, in millimetres (with floor.tilew). | |
| floor.tilew | No | Floor tiles: one side of a tile, in millimetres, for a count of tiles (with floor.tileh). Optional; the boxes are still counted by area. | |
| loft.target | No | Chosen target insulation depth in millimetres. | |
| paper.match | No | How the pattern lines up. straight and half-drop need paper.repeat. unsure, or left out with no repeat, is counted as a straight match with a 64 cm repeat (three drops a roll at an ordinary ceiling), which keeps the rolls from running short; the line names it. | |
| paper.paste | No | Rolls one packet of paste does. | |
| paper.width | No | Roll width in centimetres. Custom only: with quick the example is used, and a figure sent here is named in ignored[] as not used. | |
| patio.extra | No | Percent to add for cuts. | |
| patio.house | No | Whether the patio is against the house along one side: yes or no. It decides how many edges the sub-base runs 150 mm past and how much edge restraint is counted. Left out, it is counted as against the house along its longest side, and the sub-base line carries the question. | |
| patio.joint | No | Joint width in millimetres. The makers' guides give 10 mm as the minimum. | |
| patio.width | No | One side of a slab in millimetres. | |
| skirtingoff | No | Flooring jobs: is the skirting coming off, to go back over the new floor's edge? yes leaves the scotia beading out; no counts it in 2.4 m lengths. Left out, the beading is counted and its line carries the question to ask. | |
| woodsurface | No | With woodwork=paint: what the woodwork is like now. Default sound (painted before and sound). bare adds a check line for knotting, primer and undercoat; flaking adds the note about old paint. | |
| board.finish | No | How the boards will be finished. | |
| board.fixing | No | How the boards will be fixed. | |
| board.layers | No | Whole layers from the complete system specification. Custom only: with quick the example is used, and a figure sent here is named in ignored[] as not used. | |
| board.length | No | Board length in metres. Custom only: with quick the example is used, and a figure sent here is named in ignored[] as not used. | |
| carpet.width | No | The fixed width of the carpet roll in metres. Left out with carpet=quick: the standard width (4 or 5 m; 2, 3 or 4 m for sheet vinyl) that needs least roll for the room, said so on the list. | |
| ceilingpaint | No | Whether the ceiling paint uses the labelled example figures (quick) or figures read off the tin (custom). Needed for the keys below to take effect. | |
| colourchange | No | Painting jobs: is the colour going much lighter or darker? yes adds one coat to the walls. Left out, two coats are counted and the wall paint's line carries the question to ask. | |
| concrete.mix | No | Which of the maker's published mixes the cement, sand and aggregate follow: general purpose, paving or foundation. Mixed on site only. | |
| floor.trowel | No | Floor tiles: the notched trowel, 6 or 12 (mm). The adhesive is counted from it; left out, the one the adhesive maker's sheet gives for the tile's size (6 up to 300 mm on its long side, 12 above). | |
| paper.length | No | Roll length in metres. Custom only: with quick the example is used, and a figure sent here is named in ignored[] as not used. | |
| paper.repeat | No | Pattern repeat in centimetres. 0 or left out for none. | |
| patio.cement | No | Parts of cement in the bed, by volume. | |
| patio.covers | No | Square metres one pack covers, from the pack, for a project pack of mixed sizes; optional, and it beats patio.pack. With it, whole packs are counted by area. | |
| patio.length | No | The other side of a slab in millimetres. | |
| patio.primer | No | Square metres one tub of slurry primer covers, from the tub; optional. Without it the tubs are counted from a typical 12 m² a tub, said to be typical. | |
| trim.breasts | No | How many chimney breasts the new skirting goes round: each adds its two returns. Left out: none. | |
| walls.length | No | Paint, tiles or wallpaper on some walls only (a splashback, a shower's walls, a feature wall): the total length of the walls covered, in the units. It replaces the room's perimeter for the paint, the tiles' area and the paper's drops; doors and windows are then not taken off. Left out: all the walls. Sent with a height and with no length, width, plan or area, it is a wall on its own: the room is not needed (walls only: no ceiling, woodwork, floor or skirting). | |
| concrete.bags | No | How the sand, aggregate or ballast of a mix on site, and the sub-base, are bought: bulk (bulk bags of about 800 kg) or bags (25 kg bags). Bulk unless given; each is counted in whole bags from a typical figure that names its source. | |
| concrete.step | No | The step in cubic metres the supplier sells ready-mixed concrete in. Ready-mixed only; optional. | |
| floor.pattern | No | How the floor is laid: straight, brick, diagonal or herringbone. A diagonal or herringbone lay takes 15% for cuts where a straight lay takes 10%, unless floor.extra gives another figure. Left out: straight. | |
| loft.existing | No | Existing insulation depth in millimetres. | |
| loft.overpack | No | Square metres one roll of the second insulation covers; optional for a 100, 150, 170 or 200 mm roll. | |
| walltiles.box | No | Metres squared in one box. Custom only: with quick the example is used, and a figure sent here is named in ignored[] as not used. | |
| board.adhesive | No | Wall boards one bag of plasterboard adhesive fixes, from its instructions. | |
| concrete.extra | No | Percent to add for an uneven base and spillage. With quick, a figure sent here is used and labelled as the person's; the ones not sent stay the labelled examples. | |
| concrete.yield | No | Cubic metres one bag makes, as printed on the bag. Bags only. With quick, a figure sent here is used and labelled as the person's; the ones not sent stay the labelled examples. | |
| floor.adhesive | No | Floor tiles: metres squared one bag of adhesive covers. | |
| floor.covering | No | What the floor is. Default laminate. | |
| floor.groutbag | No | Floor tiles: the weight of one bag of grout in kilograms; 5 when left out. | |
| floor.underlay | No | Whether underlay is needed. | |
| patio.jointing | No | Square metres one pail of jointing compound covers at your joint, from the pail; optional. Without it the pails are counted from a typical 7 m² a pail, said to be typical. | |
| patio.subdepth | No | Depth of the sub-base under the patio in millimetres, decided for the job; optional. Without it the makers' usual minimum of 100 mm is used, said to be typical. | |
| wallpaint.tins | No | Tin sizes in litres, comma separated, for the wall paint. A size may carry a price after "@": the price is accepted and ignored. | |
| woodpaint.tins | No | Tin sizes in litres, comma separated, for the woodwork paint (with woodwork=paint). A size may carry a price after "@": the price is accepted and ignored. | |
| carpet.covering | No | What is laid from the roll: carpet (with underlay and gripper) or sheet vinyl (loose laid, taped or glued; no underlay). Sheet vinyl is sold in 2, 3 and 4 m widths; its quick example is a 3 m roll. | |
| carpet.underlay | No | Metres squared covered by one chosen underlay roll or pack. | |
| concrete.supply | No | bags: bags of dry mix; mix: cement with sand and aggregate, mixed on site; mixed: ready-mixed concrete, delivered by the cubic metre. Mind the two: "mix" is mixed on site, "mixed" arrives mixed. Left out, the planner follows the slab's volume (bags up to 0.25 m³, mixed on site up to 1 m³, ready-mixed above) and the answer says what each of the three ways takes. | |
| concrete.weight | No | The weight of one bag in kilograms. Bags only. With quick, a figure sent here is used and labelled as the person's; the ones not sent stay the labelled examples. | |
| wallpaint.coats | No | Coats on the tin, for the wall paint. With quick, a figure sent here is used and labelled as the person's; the ones not sent stay the labelled examples. | |
| wallpaint.extra | No | Percent to add for waste and touch-ups, for the wall paint. With quick, a figure sent here is used and labelled as the person's; the ones not sent stay the labelled examples. | |
| walltiles.depth | No | The wall tile's thickness in millimetres, for the grout. Left out, a typical 8 mm is used and said so. | |
| walltiles.extra | No | Percent to add for cuts. Custom only: with quick the example is used, and a figure sent here is named in ignored[] as not used. | |
| walltiles.grout | No | Metres squared one bag of grout covers. | |
| walltiles.joint | No | The joint width in millimetres. With the tile size, the grout is counted by the makers' rule; left out, a typical 2 mm joint is used and said so. | |
| walltiles.tileh | No | The other side of a wall tile, in millimetres (with walltiles.tilew). | |
| walltiles.tilew | No | One side of a wall tile, in millimetres, for a count of tiles (with walltiles.tileh). Optional; the boxes are still counted by area. | |
| woodpaint.coats | No | Coats on the tin, for the woodwork paint (with woodwork=paint). With quick, a figure sent here is used and labelled as the person's; the ones not sent stay the labelled examples. | |
| woodpaint.extra | No | Percent to add for waste and touch-ups, for the woodwork paint (with woodwork=paint). With quick, a figure sent here is used and labelled as the person's; the ones not sent stay the labelled examples. | |
| carpet.allowance | No | The trimming allowance in metres, added once to each room measurement. | |
| carpet.direction | No | Which way the pile or pattern must run. Not decided lets the planner show the smaller one-piece cut that fits. | |
| lengths.skirting | No | Length the skirting is sold in, in metres. Custom only: with quick the example is used, and a figure sent here is named in ignored[] as not used. | |
| trim.breastdepth | No | How deep a chimney breast is, in millimetres. Left out: 350, an example depth, said to be one. | |
| walltiles.height | No | Metres up the wall the tiles go. Left out: to the ceiling. | |
| walltiles.reveal | No | How deep the window reveals are, in millimetres, on walls tiled to the ceiling: the reveals are tiled too. Left out: 150, an example depth, said to be one. 0 leaves them out. | |
| walltiles.trowel | No | The notched trowel, 6 or 12 (mm). The adhesive is counted from it; 6 when left out. | |
| ceilingpaint.tins | No | Tin sizes in litres, comma separated, for the ceiling paint. A size may carry a price after "@": the price is accepted and ignored. | |
| concrete.subdepth | No | Depth of the sub-base under the slab in millimetres, decided for the job; optional. With it, the sub-base is counted in bulk bags or 25 kg bags from a typical figure that names its source. | |
| floor.adhesivebag | No | Floor tiles: the weight of one bag of adhesive in kilograms; 20 when left out. | |
| walltiles.pattern | No | How the wall tiles are laid: straight, brick, diagonal or herringbone. A diagonal or herringbone lay takes 15% for cuts where a straight lay takes 10%, unless walltiles.extra gives another figure. Left out: straight. | |
| ceilingpaint.coats | No | Coats on the tin, for the ceiling paint. With quick, a figure sent here is used and labelled as the person's; the ones not sent stay the labelled examples. | |
| ceilingpaint.extra | No | Percent to add for waste and touch-ups, for the ceiling paint. With quick, a figure sent here is used and labelled as the person's; the ones not sent stay the labelled examples. | |
| concrete.aggregate | No | Whether the aggregate is bought as all-in ballast or as sharp sand and coarse aggregate. Mixed on site only. | |
| concrete.thickness | No | Slab thickness in millimetres, decided for the job. BuildBatch suggests none. With quick, a figure sent here is used and labelled as the person's; the ones not sent stay the labelled examples. | |
| lengths.architrave | No | Length the architrave is sold in, in metres. Custom only: with quick the example is used, and a figure sent here is named in ignored[] as not used. | |
| wallpaint.coverage | No | Metres squared covered by one litre in one coat, from the tin, for the wall paint. With quick, a figure sent here is used and labelled as the person's; the ones not sent stay the labelled examples. | |
| walltiles.adhesive | No | Metres squared one bag of adhesive covers. | |
| walltiles.groutbag | No | The weight of one bag of grout in kilograms; 5 when left out. | |
| woodpaint.coverage | No | Metres squared covered by one litre in one coat, from the tin, for the woodwork paint (with woodwork=paint). With quick, a figure sent here is used and labelled as the person's; the ones not sent stay the labelled examples. | |
| floor.underlay.roll | No | Metres squared in one roll of underlay. | |
| ceilingpaint.coverage | No | Metres squared covered by one litre in one coat, from the tin, for the ceiling paint. With quick, a figure sent here is used and labelled as the person's; the ones not sent stay the labelled examples. | |
| walltiles.adhesivebag | No | The weight of one bag of adhesive in kilograms; 20 when left out. |