GETNo key

Sample load plan

GETapi.navo24.com/v1/loading/plan/demo

A rich sample plan for a 40HC shipment, real planner output on synthetic cargo, marked _demo: true. No key. Use it to see the response shape before you sign up. Trimmed in the example.

Response schema

39 fields

Derived from the example response, nested as the JSON is.

_demoboolean

enginestring

Solver that produced the plan.

equipmentobject

Equipment and cargo particulars, present only when the line publishes at least one of them. Absent entirely on a line that publishes none, which is not the same as a block full of nulls.

codestring

Event or status code.

namestring

Human-readable name.

internal_mobject

lengthnumber

widthnumber

heightnumber

max_payload_kgnumber

rated_max_gross_kgnumber

resultobject

containers_usednumber

loaded_itemsnumber

unloaded_itemsnumber

volume_utilization_pctnumber

weight_utilization_pctnumber

total_weight_kgnumber

center_of_gravityobject

offset_pctobject

xnumber

ynumber

eccentricity_pctobject

longitudinalnumber

lateralnumber

within_toleranceboolean

stabilityobject

floor_firstboolean

floor_utilization_pctnumber

tiersnumber

vertical_cog_pctnumber

top_heavyboolean

vgm_kgnumber

Verified gross mass, kilograms. Null until the shipper files a VGM and the carrier publishes it.

vgm_within_csc_limitboolean

floor_loadobject

peak_kg_per_mnumber

limit_kg_per_mnumber

within_limitboolean

axle_compliancestring

Errors

A failure on an open endpoint answers { "ok": false } with a human-readable message. Branch on the status code.

RATE_LIMITED429

Too many requests from one IP.

Try itNo key

curl 'https://api.navo24.com/v1/loading/plan/demo'

const res = await fetch("https://api.navo24.com/v1/loading/plan/demo");
const data = await res.json();

import requests

res = requests.get("https://api.navo24.com/v1/loading/plan/demo")
data = res.json()

Sample response example

{
  "_demo": true,
  "engine": "offline-preview",
  "equipment": {
    "code": "40HC",
    "name": "40' High Cube",
    "internal_m": {
      "length": 12,
      "width": 2.4,
      "height": 2.7
    },
    "max_payload_kg": 26460,
    "rated_max_gross_kg": 32500
  },
  "result": {
    "containers_used": 1,
    "loaded_items": 34,
    "unloaded_items": 0,
    "volume_utilization_pct": 85.1,
    "weight_utilization_pct": 83.1,
    "total_weight_kg": 22000,
    "center_of_gravity": {
      "offset_pct": {
        "x": -8,
        "y": -1
      },
      "eccentricity_pct": {
        "longitudinal": -4,
        "lateral": -0.5
      },
      "within_tolerance": true
    },
    "stability": {
      "floor_first": true,
      "floor_utilization_pct": 92,
      "tiers": 2,
      "vertical_cog_pct": 48,
      "top_heavy": false
    },
    "vgm_kg": 25940,
    "vgm_within_csc_limit": true,
    "floor_load": {
      "peak_kg_per_m": 2123,
      "limit_kg_per_m": 3000,
      "within_limit": true
    },
    "axle_compliance": "ok"
  }
}

This preview uses documented example data and makes no live request.Get a key to run live.