osrmroute
DokuSchnellstart
API-Dokumentation

Ladeplanungs-API und Anleitung zur 3D-Integration

Senden Sie eine Ladeliste über die REST-API, rufen Sie Platzierung und Beladeschritte ab und zeigen Sie das geprüfte 3D-Modell in Ihrer Anwendung an.

Preise für die 3D-Ladeplanung

Jeder Vorgang hat einen Gesamtpreis in gekauften Credits. Ein geprüfter vollständiger oder zugelassener Teilplan wird gemäß den Regeln des Vorgangs berechnet. Ohne abrechenbares Ergebnis wird die Reservierung freigegeben.

Preise für die 3D-Ladeplanung
ModulCredits pro Vorgang
Standard-LadeplanPOST /api/v1/load-plans30 Credits
Manuelle PlatzierungsrevisionPOST /api/v1/load-plans/{id}/placement-revisions5 Credits
PalettenplanungPOST /api/v1/load-plans/palletize30 Credits
AusrüstungsvergleichPOST /api/v1/load-plans/compare40 Credits
Ladeplan mit mehreren StoppsPOST /api/v1/load-plans/multi-stop50 Credits
Große Ladeliste129–256 Ladeeinheiten pro PlanPOST /api/v1/load-plans/bulk50 Credits
Aufteilung auf mehrere FahrzeugePOST /api/v1/load-plans/fleet70 Credits
Fahrzeug- und RoutenvergleichPOST /api/v1/load-plans/dispatch100 Credits
PalettenverladungPOST /api/v1/load-plans/fulfillment60 Credits
Simulation historischer SendungenPOST /api/v1/load-plans/simulation200 Credits
KartonplanungPOST /api/v1/load-plans/packaging30 Credits

Platzierungsvorschau und Export des geprüften Ergebnisses kosten keine zusätzlichen Credits. Das Speichern einer geprüften Platzierungsrevision hat einen eigenen Preis.

Rufen Sie vor dem Absenden die aktuellen Preise ab. Übergeben Sie bei separat berechneten Modulen den aktuellen Creditpreis im Header Confirm-Load-Credits. Ein Preis von null bedeutet, dass der Vorgang nicht verfügbar ist.

GET /api/v1/load-plans/prices
curl --fail -H "Authorization: Bearer $OSRM_API_KEY" https://osrmroute.com/api/v1/load-plans/prices

Synthetischen Auftrag senden

  1. Erstellen Sie einen Live-API-Schlüssel mit route-Berechtigung für Ihr Projekt. Senden Sie ihn von Ihrem Server als Bearer-Token.
  2. Verwenden Sie einheitliche Maßeinheiten in der JSON-Ladeliste. Geben Sie Öffnung, Innenmaße und Nutzlast sowie Maße, Gewicht, Stückzahl, Ausrichtungen und Stopps an.
  3. Setzen Sie vor dem Senden einen Idempotency-Key. Speichern Sie die Job-ID aus der Antwort 202. Wiederholen Sie eine Anfrage bei verlorener Antwort mit demselben Schlüssel. Beachten Sie Retry-After bei Statusabfragen.
POST /api/v1/load-plans
curl -i -X POST "https://osrmroute.com/api/v1/load-plans" \
  -H "Authorization: Bearer $OSRM_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: synthetic-truck-01' \
  --data-binary @truck.json
truck.json
{
  "units": {
    "length": "mm",
    "mass": "kg"
  },
  "equipment": {
    "id": "synthetic-truck",
    "kind": "truck",
    "source": "template",
    "inside": [
      6000,
      2400,
      2400
    ],
    "outside": [
      7200,
      2500,
      3600
    ],
    "door": {
      "left": 25,
      "width": 2350,
      "height": 2300
    },
    "payload": 8000,
    "tare": 6500,
    "clearance": 25,
    "obstacles": []
  },
  "stops": [
    "s1",
    "s2"
  ],
  "items": [
    {
      "id": "p1",
      "size": [
        1200,
        800,
        1100
      ],
      "mass": 350,
      "quantity": 1,
      "stopId": "s1",
      "orientations": [
        "lwh",
        "wlh"
      ],
      "stacking": "floor_only"
    },
    {
      "id": "p2",
      "size": [
        1200,
        800,
        1100
      ],
      "mass": 350,
      "quantity": 1,
      "stopId": "s2",
      "orientations": [
        "lwh",
        "wlh"
      ],
      "stacking": "floor_only"
    }
  ],
  "allowPartial": false
}
mixed-stack.json
{
  "units": {
    "length": "mm",
    "mass": "kg"
  },
  "equipment": {
    "id": "synthetic-compact-truck",
    "kind": "truck",
    "source": "template",
    "inside": [
      2400,
      1000,
      1500
    ],
    "outside": [
      3000,
      1200,
      1800
    ],
    "door": {
      "left": 0,
      "width": 1000,
      "height": 1500
    },
    "payload": 1000,
    "tare": 600,
    "clearance": 0,
    "obstacles": []
  },
  "stops": [
    "first",
    "second"
  ],
  "items": [
    {
      "id": "small",
      "size": [
        800,
        650,
        400
      ],
      "mass": 70,
      "quantity": 2,
      "stopId": "first",
      "orientations": [
        "lwh"
      ],
      "stacking": "stackable"
    },
    {
      "id": "medium",
      "size": [
        1050,
        850,
        450
      ],
      "mass": 90,
      "quantity": 2,
      "stopId": "first",
      "orientations": [
        "lwh"
      ],
      "stacking": "stackable",
      "maxTopMass": 100
    },
    {
      "id": "base",
      "size": [
        1200,
        1000,
        600
      ],
      "mass": 160,
      "quantity": 2,
      "stopId": "second",
      "orientations": [
        "lwh"
      ],
      "stacking": "floor_only",
      "maxTopMass": 180
    }
  ],
  "allowPartial": false
}

Ergebnis lesen

Ein abgeschlossener Auftrag liefert eine geprüfte Platzierung, einen Unmöglichkeitsnachweis, keinen gefundenen Plan oder ein Suchlimit. Teilbeladung erfordert ausdrückliche Zustimmung.

Prüfen Sie result.status und billing.status getrennt. Ein abgeschlossener Job kann ohne nutzbare Platzierung enden. Prüfen Sie bei einem erlaubten Teilplan vor dem Versand die nicht platzierten Einheiten.

Status mit GET und der zurückgegebenen Auftrags-ID abfragen. Cancel fordert den Abbruch eines wartenden oder laufenden Auftrags an. DELETE löscht gespeicherte Eingaben und Ergebnisse eines abgeschlossenen Auftrags.

GET /api/v1/load-plans/{id}
curl --include -H "Authorization: Bearer $OSRM_API_KEY" \
  "https://osrmroute.com/api/v1/load-plans/$JOB_ID"
  • GET /api/v1/load-plans/{id}
  • POST /api/v1/load-plans/{id}/cancel
  • DELETE /api/v1/load-plans/{id}

Der Export erfordert einen geprüften Plan und eine Exportberechtigung. Arbeitsblatt als HTML, Tabelle als CSV und 3D-Modell als GLB herunterladen.

  • GET /api/v1/load-plans/{id}/worksheet
  • GET /api/v1/load-plans/{id}/csv

Senden Sie für eine Revision den aktualisierten Auftrag mit Revises-Load-Plan und einem neuen Idempotenzschlüssel. Die neueste geprüfte Revision kann exportiert werden.

Die Berechnung verwendet die angegebenen Maße und Einschränkungen. Prüfen Sie vor dem Verladen die tatsächlichen Maße, Freiräume, Ladungssicherung, Achslasten und geltenden Vorschriften mit dem Betriebspersonal.

Ausrüstungsvergleich, Flotte und Paletten

Der Unternehmensserver verwendet seinen Projektschlüssel, liest den aktuellen Preis und reiht die bestätigte Anfrage ein.

  • GET /api/v1/load-plans/prices
  • POST /api/v1/load-plans/import-preview
  • POST /api/v1/load-plans/compare
  • POST /api/v1/load-plans/fleet
  • POST /api/v1/load-plans/palletize
  • POST /api/v1/load-plans/multi-stop
  • POST /api/v1/load-plans/bulk
  • POST /api/v1/load-plans/packaging
  • POST /api/v1/load-plans/dispatch · Fahrzeug- und Routenvergleich
  • POST /api/v1/load-plans/fulfillment · Palettenverladung
  • GET, POST /api/v1/load-plans/{id}/warehouse · Lagerausführung
  • POST /api/v1/load-plans/simulation · Simulation historischer Sendungen
  • GET /api/v1/load-plans/{id}/simulation-report · CSV
  • GET /api/v1/load-plans/partner · Partnerprojekt
  • POST /api/v1/load-plans/{id}/axle-estimate
  • GET /api/v1/load-plans/webhook/events
  • POST /api/v1/load-plans/{id}/placement-preview
  • POST /api/v1/load-plans/{id}/placement-revisions
  • GET /api/v1/load-plans/{id}/pdf
  • GET /api/v1/load-plans/{id}/xlsx
  • POST /api/v1/load-plans/{id}/share
  • GET /api/v1/load-plans/workspace/{kind}

Kartonplanung

Übermitteln Sie Maße und Gewichte der Artikel einer Bestellung. Wählen Sie einen passenden Katalogkarton, schlagen Sie neue Maße vor oder berechnen Sie die Stückzahl je Karton.

Rufen Sie vor dem Absenden die aktuellen Preise ab. Übergeben Sie bei separat berechneten Modulen den aktuellen Creditpreis im Header Confirm-Load-Credits. Ein Preis von null bedeutet, dass der Vorgang nicht verfügbar ist.

POST /api/v1/load-plans/packaging
curl --fail-with-body -X POST "https://osrmroute.com/api/v1/load-plans/packaging" \
  -H "Authorization: Bearer $OSRM_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Confirm-Load-Credits: $CONFIRMED_CREDITS" \
  --data-binary @packaging.json
packaging.json
{
  "operation": "choose_carton",
  "units": {
    "length": "mm",
    "mass": "g"
  },
  "stops": [
    "order"
  ],
  "items": [
    {
      "id": "sku",
      "size": [
        50,
        50,
        50
      ],
      "mass": 100,
      "quantity": 2,
      "stopId": "order",
      "orientations": [
        "lwh"
      ],
      "stacking": "floor_only"
    }
  ],
  "cartons": [
    {
      "id": "standard",
      "inside": [
        110,
        110,
        110
      ],
      "payload": 1000,
      "tare": 10
    }
  ]
}

Fahrzeug- und Routenvergleich

Vergleichen Sie Einzelfahrzeuge und Flotten für dieselbe Sendung nach Beladung, Strecke, Dauer, Kosten zu Ihren Tarifen und Fahrzeugzahl. Routen hängen von der Truck-Routing-Abdeckung ab.

Rufen Sie vor dem Absenden die aktuellen Preise ab. Übergeben Sie bei separat berechneten Modulen den aktuellen Creditpreis im Header Confirm-Load-Credits. Ein Preis von null bedeutet, dass der Vorgang nicht verfügbar ist.

POST /api/v1/load-plans/dispatch
curl --fail-with-body -X POST "https://osrmroute.com/api/v1/load-plans/dispatch" \
  -H "Authorization: Bearer $OSRM_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Confirm-Load-Credits: $CONFIRMED_CREDITS" \
  --data-binary @dispatch.json
dispatch.json
{
  "manifest": {
    "units": {
      "length": "mm",
      "mass": "kg"
    },
    "stops": [
      "s1"
    ],
    "items": [
      {
        "id": "p1",
        "size": [
          1200,
          800,
          1100
        ],
        "mass": 350,
        "quantity": 1,
        "stopId": "s1",
        "orientations": [
          "lwh",
          "wlh"
        ],
        "stacking": "floor_only"
      }
    ],
    "allowPartial": false
  },
  "currency": "USD",
  "points": [
    [
      49.865,
      40.405
    ],
    [
      49.902,
      40.421
    ]
  ],
  "alternatives": [
    {
      "id": "standard",
      "vehicles": [
        {
          "equipment": {
            "id": "synthetic-truck",
            "kind": "truck",
            "source": "template",
            "inside": [
              6000,
              2400,
              2400
            ],
            "outside": [
              7200,
              2500,
              3600
            ],
            "door": {
              "left": 25,
              "width": 2350,
              "height": 2300
            },
            "payload": 8000,
            "tare": 6500,
            "clearance": 25,
            "obstacles": []
          },
          "vehicle": {
            "height_m": 3.6,
            "width_m": 2.5,
            "length_m": 7.2,
            "weight_t": 14.5,
            "axle_load_t": 8,
            "axle_count": 2
          },
          "baseMinor": 850,
          "perKilometerMinor": 160
        }
      ]
    }
  ]
}

Palettenverladung

Packen Sie Artikel auf Paletten und verladen Sie diese in einen Lkw. Sehen Sie Inhalt, 3D-Ansicht und Ladereihenfolge. Das Lagerteam scannt Barcodes und erfasst Abweichungen je Planrevision.

Rufen Sie vor dem Absenden die aktuellen Preise ab. Übergeben Sie bei separat berechneten Modulen den aktuellen Creditpreis im Header Confirm-Load-Credits. Ein Preis von null bedeutet, dass der Vorgang nicht verfügbar ist.

POST /api/v1/load-plans/fulfillment
curl --fail-with-body -X POST "https://osrmroute.com/api/v1/load-plans/fulfillment" \
  -H "Authorization: Bearer $OSRM_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Confirm-Load-Credits: $CONFIRMED_CREDITS" \
  --data-binary @fulfillment.json
fulfillment.json
{
  "pallet": {
    "pallet": {
      "lengthMm": 1200,
      "widthMm": 800,
      "deckHeightMm": 145,
      "maxTotalHeightMm": 1250,
      "tareG": 20000,
      "maxCargoMassG": 1000000,
      "maxPallets": 2,
      "maxLayers": 3
    },
    "stopId": "s1",
    "items": [
      {
        "id": "carton",
        "size": [
          400,
          400,
          300
        ],
        "mass": 10000,
        "quantity": 5,
        "stopId": "s1",
        "orientations": [
          "lwh"
        ],
        "stacking": "stackable",
        "maxTopMass": 30000
      }
    ],
    "allowPartial": false
  },
  "truckEquipment": {
    "id": "synthetic-truck",
    "kind": "truck",
    "source": "template",
    "inside": [
      6000,
      2400,
      2400
    ],
    "outside": [
      7200,
      2500,
      3600
    ],
    "door": {
      "left": 25,
      "width": 2350,
      "height": 2300
    },
    "payload": 8000000,
    "tare": 6500000,
    "clearance": 25,
    "obstacles": []
  }
}

GET /api/v1/load-plans/{id}/warehouse

POST /api/v1/load-plans/{id}/warehouse
{
  "revision": 1,
  "eventId": "scan-0001",
  "unitId": "pallet-1:1"
}

Simulation historischer Sendungen

Berechnen Sie frühere Sendungen mit derselben Ladung in zwei Szenarien. Erhalten Sie Fahrzeugzahl, Auslastung, nicht verladene Einheiten und bekannte Kostendifferenzen in JSON und CSV.

Rufen Sie vor dem Absenden die aktuellen Preise ab. Übergeben Sie bei separat berechneten Modulen den aktuellen Creditpreis im Header Confirm-Load-Credits. Ein Preis von null bedeutet, dass der Vorgang nicht verfügbar ist.

POST /api/v1/load-plans/simulation
curl --fail-with-body -X POST "https://osrmroute.com/api/v1/load-plans/simulation" \
  -H "Authorization: Bearer $OSRM_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Confirm-Load-Credits: $CONFIRMED_CREDITS" \
  --data-binary @simulation.json
simulation.json
{
  "currency": "USD",
  "shipments": [
    {
      "id": "demo-shipment",
      "manifest": {
        "units": {
          "length": "mm",
          "mass": "kg"
        },
        "stops": [
          "s1"
        ],
        "items": [
          {
            "id": "p1",
            "size": [
              1200,
              800,
              1100
            ],
            "mass": 350,
            "quantity": 1,
            "stopId": "s1",
            "orientations": [
              "lwh",
              "wlh"
            ],
            "stacking": "floor_only"
          }
        ],
        "allowPartial": false
      },
      "baseline": {
        "version": "2026-a",
        "alternatives": [
          {
            "id": "synthetic-truck",
            "kind": "truck",
            "source": "template",
            "inside": [
              6000,
              2400,
              2400
            ],
            "outside": [
              7200,
              2500,
              3600
            ],
            "door": {
              "left": 25,
              "width": 2350,
              "height": 2300
            },
            "payload": 8000,
            "tare": 6500,
            "clearance": 25,
            "obstacles": []
          }
        ],
        "vehicleCostMinor": {
          "synthetic-truck": 1500
        }
      },
      "proposed": {
        "version": "2026-b",
        "alternatives": [
          {
            "id": "synthetic-truck",
            "kind": "truck",
            "source": "template",
            "inside": [
              6000,
              2400,
              2400
            ],
            "outside": [
              7200,
              2500,
              3600
            ],
            "door": {
              "left": 25,
              "width": 2350,
              "height": 2300
            },
            "payload": 8000,
            "tare": 6500,
            "clearance": 25,
            "obstacles": []
          }
        ],
        "vehicleCostMinor": {
          "synthetic-truck": 1250
        }
      }
    }
  ]
}

GET /api/v1/load-plans/{id}/simulation-report · CSV

Partnerprojekt

Trennen Sie Kunden durch eigene Projekte und API-Schlüssel. Der Kontoinhaber legt Monatslimit, erlaubten HTTPS-Origin und Marke im 3D-Viewer fest.

GET /api/v1/load-plans/partner
curl --fail -H "Authorization: Bearer $OSRM_API_KEY" https://osrmroute.com/api/v1/load-plans/partner
POST /api/v1/load-plans/{id}/share
{
  "expiresInSeconds": 900,
  "partnerEmbed": true
}

Das 3D-Modell in Ihrer Anwendung anzeigen

Die geprüfte 3D-Szene enthält Laderaum, Öffnung, Hindernisse sowie die Koordinaten und orientierten Abmessungen der platzierten Einheiten in Millimetern.

Prüfen Sie Lade- und Entladeschritte in 3D. Zeigen Sie den geprüften Plan im TMS, WMS oder Kundenportal per befristetem iframe oder öffnen Sie die GLB-Datei im eigenen Viewer.

Laden Sie den letzten geprüften Plan als GLB über Ihren Server herunter. Für den Export fallen keine zusätzlichen Credits an.

GET /api/v1/load-plans/{id}/model
curl --fail -H "Authorization: Bearer $OSRM_API_KEY" \
  "https://osrmroute.com/api/v1/load-plans/$JOB_ID/model" -o load-plan.glb

Die Beispiel-URL /internal steht für eine geschützte Route in Ihrer Anwendung. Bewahren Sie den OSRMRoute-API-Schlüssel auf Ihrem Server auf.

Three.js · GLTFLoader
import { GLTFLoader } from 'three/addons/loaders/GLTFLoader.js';

const path = '/internal/load-plans/' + encodeURIComponent(jobId) + '/model';
const response = await fetch(path, { credentials: 'same-origin' });
if (!response.ok) throw new Error('Load model unavailable');
const { scene: loadModel } = await new GLTFLoader().parseAsync(await response.arrayBuffer(), '');
viewerScene.add(loadModel);
POST /api/v1/load-plans/{id}/share
{
  "expiresInSeconds": 900,
  "embedOrigin": "https://warehouse.example.com"
}
iframe
<iframe title="3D load plan" src="https://osrmroute.com{path}"
  width="100%" height="640" loading="lazy" referrerpolicy="no-referrer"
  sandbox="allow-scripts allow-same-origin"></iframe>

OSRMRoute Support

Schreiben Sie direkt unserem Team

WIR HELFEN IHNEN

Wie können wir helfen?

Senden Sie eine Nachricht. Ticketantworten gehen auch an Ihre bestätigte E-Mail-Adresse.

Ihre Chats

Ihre Chats erscheinen hier.