osrmroute
DocumentaciónInicio rápido
Documentación de la API

API de planificación de carga y guía de integración 3D

Envía la lista de carga por la API REST, recupera las posiciones y los pasos de carga y muestra el modelo 3D verificado en tu propia aplicación.

Tarifas de planificación de carga 3D

Cada operación tiene un precio total en créditos comprados. Un plan completo verificado o un plan parcial autorizado se cobra según las reglas de la operación. Si el trabajo termina sin un resultado facturable, se libera la reserva.

Tarifas de planificación de carga 3D
MóduloCréditos por operación
Plan de carga estándarPOST /api/v1/load-plans30 créditos
Revisión manual de la colocaciónPOST /api/v1/load-plans/{id}/placement-revisions5 créditos
Planificación de palésPOST /api/v1/load-plans/palletize30 créditos
Comparación de equiposPOST /api/v1/load-plans/compare40 créditos
Plan de carga con varias paradasPOST /api/v1/load-plans/multi-stop50 créditos
Lista de carga grandeDe 129 a 256 unidades por planPOST /api/v1/load-plans/bulk50 créditos
Distribución en varios vehículosPOST /api/v1/load-plans/fleet70 créditos
Comparación de vehículos y rutasPOST /api/v1/load-plans/dispatch100 créditos
Carga de palés en camiónPOST /api/v1/load-plans/fulfillment60 créditos
Simulación de envíos históricosPOST /api/v1/load-plans/simulation200 créditos
Planificación de cajasPOST /api/v1/load-plans/packaging30 créditos

La vista previa de colocación y la exportación del resultado verificado no consumen créditos adicionales. Guardar una revisión de colocación verificada tiene un precio propio.

Consulta los precios vigentes antes de enviar un trabajo. Para un módulo con precio propio, envía el precio actual en créditos en la cabecera Confirm-Load-Credits. Un precio null indica que la operación no está disponible.

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

Enviar un trabajo sintético

  1. Crea una clave de API de producción vinculada al proyecto con permiso route. Envíala desde tu servidor como token Bearer.
  2. Utiliza unidades coherentes en la lista JSON. Declara la abertura, las dimensiones interiores y la carga útil. Añade las dimensiones, el peso, las cantidades, las orientaciones y las paradas de la mercancía.
  3. Define Idempotency-Key antes del envío. Guarda el ID de trabajo de la respuesta 202. Si se pierde la respuesta, repite la misma solicitud con la misma clave. Sigue Retry-After al consultar el estado.
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
}

Leer el resultado

Un trabajo completado puede devolver una colocación verificada, una prueba de imposibilidad, ningún plan encontrado o un límite de búsqueda. La carga parcial requiere consentimiento explícito.

Consulta result.status y billing.status por separado. Un trabajo completado puede no incluir una colocación utilizable. Si permites un plan parcial, revisa las unidades sin colocar antes del envío.

Consulta el estado con GET y el identificador devuelto. Cancel solicita cancelar un trabajo en cola o en ejecución. DELETE elimina la entrada y el resultado guardados de un trabajo en estado terminal.

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}

Para exportar se requiere un plan verificado y permiso de exportación. La hoja se descarga en HTML, la tabla en CSV y el modelo 3D en GLB.

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

Para revisar un trabajo terminal, envíe el manifiesto actualizado con Revises-Load-Plan y una nueva clave de idempotencia. Se puede exportar la última revisión verificada.

El cálculo utiliza las medidas y restricciones indicadas. Antes de cargar, confirma con el operador las medidas reales, las holguras, la sujeción, los límites por eje y la normativa aplicable.

Comparación de equipos, flota y palés

El servidor de la empresa usa la clave de proyecto, consulta el precio y pone en cola la solicitud confirmada.

  • 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 · Comparación de vehículos y rutas
  • POST /api/v1/load-plans/fulfillment · Carga de palés en camión
  • GET, POST /api/v1/load-plans/{id}/warehouse · Operación de almacén
  • POST /api/v1/load-plans/simulation · Simulación de envíos históricos
  • GET /api/v1/load-plans/{id}/simulation-report · CSV
  • GET /api/v1/load-plans/partner · Proyecto de socio
  • 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}

Planificación de cajas

Envía las dimensiones y los pesos de los productos del pedido. Elige una caja del catálogo, sugiere nuevas dimensiones o calcula cuántas unidades iguales caben.

Consulta los precios vigentes antes de enviar un trabajo. Para un módulo con precio propio, envía el precio actual en créditos en la cabecera Confirm-Load-Credits. Un precio null indica que la operación no está disponible.

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

Comparación de vehículos y rutas

Compara un camión y una flota para el mismo envío. Revisa el encaje, la distancia, el tiempo, el coste según tus tarifas y el número de vehículos. La ruta depende de la cobertura Truck Routing.

Consulta los precios vigentes antes de enviar un trabajo. Para un módulo con precio propio, envía el precio actual en créditos en la cabecera Confirm-Load-Credits. Un precio null indica que la operación no está disponible.

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

Carga de palés en camión

Agrupa los productos en palés y carga los palés en un camión. Consulta el contenido, la vista 3D y el orden de carga. El personal puede escanear códigos y registrar incidencias por revisión.

Consulta los precios vigentes antes de enviar un trabajo. Para un módulo con precio propio, envía el precio actual en créditos en la cabecera Confirm-Load-Credits. Un precio null indica que la operación no está disponible.

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

Simulación de envíos históricos

Vuelve a calcular envíos anteriores con la misma carga en dos escenarios. Obtén vehículos, ocupación, unidades sin colocar y diferencias de costes conocidos en JSON y CSV.

Consulta los precios vigentes antes de enviar un trabajo. Para un módulo con precio propio, envía el precio actual en créditos en la cabecera Confirm-Load-Credits. Un precio null indica que la operación no está disponible.

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

Proyecto de socio

Mantén un proyecto y una clave de API por cliente. El propietario configura el límite mensual de créditos, el origen HTTPS y la marca que aparece en el visor 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
}

Mostrar el modelo 3D en tu aplicación

La escena verificada incluye el espacio de carga, la abertura, los obstáculos y las coordenadas y dimensiones orientadas de las unidades colocadas en milímetros.

Revisa los pasos de carga y descarga en 3D. Muestra un plano verificado en tu TMS, WMS o portal con un iframe temporal, o abre el GLB en tu visor.

Descarga el último plan verificado en GLB desde tu servidor. La exportación no consume créditos adicionales.

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

La URL /internal del ejemplo representa una ruta autenticada de tu aplicación. Guarda la clave de API de OSRMRoute en tu servidor.

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>

Soporte OSRMRoute

Escriba directamente a nuestro equipo

ESTAMOS PARA AYUDAR

¿Cómo podemos ayudarle?

Envía un mensaje. Las respuestas a los tickets también se envían a tu correo verificado.

Tus chats

Tus chats aparecerán aquí.