osrmroute
DocumentationDémarrage rapide
Documentation de l’API

API de planification de chargement et intégration 3D

Envoyez un manifeste via l’API REST, récupérez les positions et les étapes de chargement et affichez le modèle 3D vérifié dans votre application.

Tarifs de planification de chargement 3D

Chaque opération a un prix total en crédits achetés. Un plan complet vérifié ou un plan partiel autorisé est facturé selon les règles de l’opération. La réservation est levée si aucun résultat facturable n’est obtenu.

Tarifs de planification de chargement 3D
ModuleCrédits par opération
Plan de chargement standardPOST /api/v1/load-plans30 crédits
Révision manuelle du placementPOST /api/v1/load-plans/{id}/placement-revisions5 crédits
Planification des palettesPOST /api/v1/load-plans/palletize30 crédits
Comparaison des équipementsPOST /api/v1/load-plans/compare40 crédits
Plan de chargement à plusieurs arrêtsPOST /api/v1/load-plans/multi-stop50 crédits
Grande liste de chargementDe 129 à 256 unités par planPOST /api/v1/load-plans/bulk50 crédits
Répartition sur plusieurs véhiculesPOST /api/v1/load-plans/fleet70 crédits
Comparaison des véhicules et des itinérairesPOST /api/v1/load-plans/dispatch100 crédits
Chargement des palettesPOST /api/v1/load-plans/fulfillment60 crédits
Simulation des expéditions passéesPOST /api/v1/load-plans/simulation200 crédits
Planification des cartonsPOST /api/v1/load-plans/packaging30 crédits

La prévisualisation d’un placement et l’export d’un résultat vérifié ne consomment aucun crédit supplémentaire. L’enregistrement d’une révision vérifiée a son propre tarif.

Consultez les tarifs en vigueur avant d’envoyer une demande. Pour un module à tarif distinct, envoyez le prix actuel en crédits dans l’en-tête Confirm-Load-Credits. Un tarif null signifie que l’opération est indisponible.

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

Soumettre une tâche synthétique

  1. Créez une clé API de production liée au projet avec l’accès route. Envoyez-la depuis votre serveur en tant que jeton Bearer.
  2. Utilisez des unités cohérentes dans le manifeste JSON. Indiquez l’ouverture, les dimensions intérieures et la charge utile, puis les dimensions, le poids, les quantités, les orientations et les arrêts.
  3. Définissez Idempotency-Key avant l’envoi. Conservez l’identifiant renvoyé avec la réponse 202. Si la réponse est perdue, relancez la même demande avec la même clé. Respectez Retry-After pour les demandes d’état.
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
}

Lire le résultat

Une tâche terminée peut fournir un placement vérifié, une preuve d’impossibilité, une absence de plan ou une limite de recherche. Un placement partiel exige un accord explicite.

Vérifiez séparément result.status et billing.status. Un travail terminé peut ne pas contenir de placement utilisable. Si vous acceptez un résultat partiel, vérifiez les unités non placées avant l’expédition.

Consultez l’état avec GET et l’identifiant renvoyé. Cancel demande l’annulation d’une tâche en attente ou en cours. DELETE supprime l’entrée et le résultat conservés d’une tâche arrivée à son état final.

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}

L’export exige un plan vérifié et l’autorisation d’exporter. La fiche est téléchargée en HTML, le tableau en CSV et le modèle 3D en GLB.

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

Pour réviser une tâche terminée, soumettez le manifeste mis à jour avec Revises-Load-Plan et une nouvelle clé d’idempotence. La dernière révision vérifiée peut être exportée.

Le calcul utilise les dimensions et contraintes indiquées. Avant le chargement, vérifiez avec l’opérateur les mesures réelles, les dégagements, l’arrimage, les limites par essieu et les règles applicables.

Comparaison des équipements, flotte et palettes

Le serveur de l’entreprise utilise la clé de projet, consulte le tarif et met la demande confirmée en file d’attente.

  • 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 · Comparaison des véhicules et des itinéraires
  • POST /api/v1/load-plans/fulfillment · Chargement des palettes
  • GET, POST /api/v1/load-plans/{id}/warehouse · Exécution en entrepôt
  • POST /api/v1/load-plans/simulation · Simulation des expéditions passées
  • GET /api/v1/load-plans/{id}/simulation-report · CSV
  • GET /api/v1/load-plans/partner · Projet partenaire
  • 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}

Planification des cartons

Transmettez les dimensions et poids des articles d’une commande. Choisissez un carton du catalogue, proposez de nouvelles dimensions ou calculez la quantité d’articles identiques par carton.

Consultez les tarifs en vigueur avant d’envoyer une demande. Pour un module à tarif distinct, envoyez le prix actuel en crédits dans l’en-tête Confirm-Load-Credits. Un tarif null signifie que l’opération est indisponible.

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
    }
  ]
}

Comparaison des véhicules et des itinéraires

Comparez un camion et une flotte pour le même envoi. Consultez le chargement, la distance, la durée, le coût selon vos tarifs et le nombre de véhicules. L’itinéraire dépend de la couverture Truck Routing.

Consultez les tarifs en vigueur avant d’envoyer une demande. Pour un module à tarif distinct, envoyez le prix actuel en crédits dans l’en-tête Confirm-Load-Credits. Un tarif null signifie que l’opération est indisponible.

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
        }
      ]
    }
  ]
}

Chargement des palettes

Placez les articles sur des palettes, puis les palettes dans le camion. Consultez le contenu, la vue 3D et l’ordre de chargement. Les opérateurs scannent les codes-barres et consignent les écarts par révision.

Consultez les tarifs en vigueur avant d’envoyer une demande. Pour un module à tarif distinct, envoyez le prix actuel en crédits dans l’en-tête Confirm-Load-Credits. Un tarif null signifie que l’opération est indisponible.

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 des expéditions passées

Recalculez des expéditions passées avec le même chargement dans deux scénarios. Obtenez le nombre de véhicules, le remplissage, les unités non placées et l’écart des coûts connus en JSON et CSV.

Consultez les tarifs en vigueur avant d’envoyer une demande. Pour un module à tarif distinct, envoyez le prix actuel en crédits dans l’en-tête Confirm-Load-Credits. Un tarif null signifie que l’opération est indisponible.

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

Projet partenaire

Utilisez un projet et une clé API par client. Le propriétaire fixe le plafond mensuel de crédits, l’origine HTTPS autorisée et la marque affichée dans la visionneuse 3D.

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
}

Afficher le modèle 3D dans votre application

La scène vérifiée contient l’espace de chargement, l’ouverture, les obstacles, les coordonnées et les dimensions orientées des unités placées en millimètres.

Vérifiez les étapes de chargement et de déchargement en 3D. Affichez un plan vérifié dans un TMS, WMS ou portail via un iframe temporaire, ou ouvrez le GLB dans votre visionneuse.

Téléchargez le dernier plan vérifié au format GLB depuis votre serveur. L’export ne débite aucun crédit supplémentaire.

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

L’URL /internal de l’exemple représente une route authentifiée de votre application. Conservez votre clé API OSRMRoute sur votre serveur.

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>

Assistance OSRMRoute

Écrivez directement à notre équipe

À VOTRE ÉCOUTE

Comment vous aider ?

Envoyez un message. Les réponses aux tickets sont aussi envoyées à votre adresse e-mail vérifiée.

Vos discussions

Vos discussions apparaîtront ici.