plan_load
Compute a 3D load plan for cargo into a container or truck: containers used, utilization (volume & payload %), centre of gravity, crush-protection violations, and a securing checklist (round cargo that rolls, soft cargo that slumps). Cargo type drives realism — drums/pipes hex-nest, big bags/sacks load on top and are never crushed. Omit equipmentCode to auto right-size to the cheapest container that fits. A real API key runs the production PackingSolver optimizer; the public demo key uses the offline preview packer.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| vgm | No | SOLAS Verified Gross Mass declaration (else a tare+cargo estimate is reported) | |
| mode | No | Transport mode — scopes auto right-size to usable equipment (sea→containers, road→trucks, air→ULDs). Ignored when equipmentCode is given. | sea |
| items | Yes | Cargo lines to load | |
| topUp | No | Also return `topUp`: for each cargo line, how many MORE units still fit in the same containers with every unit placed and the load still ready (e.g. "+6 of SKU A, fill 82%"). Takes longer, since it re-plans the load per line. | |
| freight | No | Freight cost per unit: split the ocean freight for this load (rate per container x containers used) across the cargo lines, per line and per unit, so it can go into product cost. Uses the indicative market rate for the lane (20GP/40GP/40HC, real API key) or your ratePerContainer. Indicative, not a quote. No rate = freight.available false with a reason. | |
| massLimits | No | Australian mass tier (default general). hml = HVNL Higher Mass Limits for AU (tri-axle 22.5 t, 6-axle combination 45.5 t; needs an HML route, road-friendly suspension and mass accreditation) or the NT road-friendly-suspension limits for AU-NT. Ignored elsewhere. | |
| jurisdiction | No | Road jurisdiction for the axle / gross-weight compliance check (default EU). Set CN for China GB 1589 drayage limits, AU for Australian HVNL general mass limits (NSW, Vic, Qld, SA, Tas, ACT), AU-WA for Western Australia, AU-NT for the Northern Territory. Australian jurisdictions also secure to the HVNL Sch 7 loading performance standards. | |
| vesselMotion | No | IMO CSS Annex 13 vessel motion + stowage position. When set, the sea leg uses the position-dependent DYNAMIC acceleration field (a container on deck forward sees a far harsher case than one low amidships) instead of the flat sea-area coefficient. | |
| equipmentCode | No | Equipment code, e.g. 40HC (see list_equipment). Omit to auto right-size. | |
| sequenceStops | No | Delivery-stop sequencing: with ≥2 distinct deliveryStop values, zone the load nose→doors in reverse delivery order. | |
| vehicleTareKg | No | Your road vehicle tare in kg (container: prime mover + chassis/skeletal; truck: the truck). Replaces the nominal tare in the gross check (AU default 14,100 kg, elsewhere 11,600 kg for a container combination). | |
| complyingSteerAxle | No | AU only: the prime mover is an HVNL complying steer axle vehicle (6.5 t steer, 44 t combination). Default false. |