Plan a plank flooring order
plan_flooring_orderRead-onlyIdempotent
Plans laminate, vinyl plank (LVP) or engineered plank flooring for 1 to 12 rooms, rectangles or L shapes, with the plank size and planks per carton from the carton: cartons to buy, every cut piece traced to its source plank, offcuts carried from one room to the next, the 8 scenarios (direction x offset 1/3 or 1/2 x reuse, plus aligned joints in the chosen direction when offset 0 is chosen) and the best one when no other ties it (fewest cartons, then least offcut, then fewest planks), and how many planks a flat waste allowance would miss. Up to 3,000 planks per call. Lengths accept feet and inches. Returns a link per room to the full plan on calculiva.com.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kerf | No | Saw kerf, charged on each cut. Default 1/8 in. Length with its unit, e.g. "12 ft 6 in", "12'6\"", "150 in", "3m80"; a bare number is read as inches. | |
| order | No | Laying order by room name; offcuts only flow forward. Default: the order of rooms. | |
| reuse | No | Cut a row end from the offcut of a row start in the same room (default true). | |
| rooms | Yes | Rooms to floor with the same plank, 1 to 12, in laying order unless order is given. | |
| offset | No | End-joint stagger between rows, as a fraction of the plank: 1/3 (default), 1/2 or 0 (aligned). | |
| minReuse | No | Shortest offcut worth carrying to another room. Default 0 (any offcut long enough). Length with its unit, e.g. "12 ft 6 in", "12'6\"", "150 in", "3m80"; a bare number is read as inches. | |
| clearance | No | Expansion gap on every wall, from the product instructions. Default 0. Length with its unit, e.g. "12 ft 6 in", "12'6\"", "150 in", "3m80"; a bare number is read as inches. | |
| direction | No | horizontal = planks run along the room width (default); vertical = along the room length. | |
| minStarter | No | Minimum row starter length; 0 disables the check. Default 0. Length with its unit, e.g. "12 ft 6 in", "12'6\"", "150 in", "3m80"; a bare number is read as inches. | |
| plankWidth | Yes | Installed plank width (face), from the carton. Length with its unit, e.g. "12 ft 6 in", "12'6\"", "150 in", "3m80"; a bare number is read as inches. | |
| minRowWidth | No | Minimum edge-row width; 0 disables the check. Default 0. Length with its unit, e.g. "12 ft 6 in", "12'6\"", "150 in", "3m80"; a bare number is read as inches. | |
| plankLength | Yes | Installed plank length (face), from the carton. Length with its unit, e.g. "12 ft 6 in", "12'6\"", "150 in", "3m80"; a bare number is read as inches. | |
| balancedRows | No | Split the partial row width between the first and last rows (default true). | |
| firstStarter | No | Length of the first row starter; 0 = full plank. Default 0. Length with its unit, e.g. "12 ft 6 in", "12'6\"", "150 in", "3m80"; a bare number is read as inches. | |
| planksPerBox | Yes | Planks per carton, from the carton label. | |
| minJointSpacing | No | Minimum distance between end joints of adjacent rows; 0 disables the check. Default 0. Length with its unit, e.g. "12 ft 6 in", "12'6\"", "150 in", "3m80"; a bare number is read as inches. | |
| allowancePercent | No | Flat waste allowance you would otherwise buy (e.g. 10): the answer says how many planks it misses. | |
| carryBetweenRooms | No | Offcuts of a room feed the next rooms (default true). |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rooms | Yes | ||
| method | Yes | ||
| scenario | Yes | ||
| shareUrl | Yes | ||
| warnings | Yes | ||
| allowance | Yes | ||
| scenarios | Yes | ||
| transfers | Yes | ||
| boxesToBuy | Yes | ||
| offcutsLeft | Yes | ||
| planksToBuy | Yes | ||
| sparePlanks | Yes | ||
| bestScenario | Yes | The single best of the scenarios (8, or 10 when offset 0 is chosen) by comparisonRule; null when several tie. | |
| planksPerBox | Yes | ||
| sourcePlanks | Yes | ||
| wastePercent | Yes | ||
| bestDecidedBy | Yes | The first criterion of comparisonRule on which the two options differ. | |
| floorAreaSqFt | Yes | ||
| comparisonRule | Yes | The ranking used for every "better" statement in this result; a tie recommends nothing. | |
| roomsAlonePlanks | Yes | ||
| shareUrlComplete | Yes | ||
| scenariosTiedAtBest | Yes | ||
| planksSavedBetweenRooms | Yes |