API планирования загрузки и руководство по 3D
Отправьте список груза через REST API, получите размещение и шаги загрузки и покажите проверенную 3D-модель в своём приложении.
Тарифы 3D-планирования загрузки
У каждой операции одна итоговая цена в купленных кредитах. Проверенный полный план или разрешённый частичный план оплачивается по правилам операции. Если результат не подлежит оплате, резерв снимается.
| Модуль | Кредиты за операцию |
|---|---|
Стандартный план загрузкиPOST /api/v1/load-plans | 30 кр. |
Ручная правка размещенияPOST /api/v1/load-plans/{id}/placement-revisions | 5 кр. |
Планирование палетPOST /api/v1/load-plans/palletize | 30 кр. |
Сравнение оборудованияPOST /api/v1/load-plans/compare | 40 кр. |
План с несколькими остановкамиPOST /api/v1/load-plans/multi-stop | 50 кр. |
Большой список грузовОт 129 до 256 единиц груза на планPOST /api/v1/load-plans/bulk | 50 кр. |
Распределение по машинамPOST /api/v1/load-plans/fleet | 70 кр. |
Сравнение машин и маршрутовPOST /api/v1/load-plans/dispatch | 100 кр. |
Загрузка палет в машинуPOST /api/v1/load-plans/fulfillment | 60 кр. |
Моделирование прошлых отправокPOST /api/v1/load-plans/simulation | 200 кр. |
Планирование упаковкиPOST /api/v1/load-plans/packaging | 30 кр. |
Предпросмотр размещения и экспорт проверенного результата не расходуют дополнительные кредиты. У сохранения проверенной правки размещения отдельная цена.
Получите актуальные тарифы перед отправкой задания. Для модуля с отдельным тарифом передайте текущую цену в заголовке Confirm-Load-Credits. Цена null означает, что операция недоступна.
curl --fail -H "Authorization: Bearer $OSRM_API_KEY" https://osrmroute.com/api/v1/load-plans/pricesОтправить синтетическое задание
- Создайте рабочий ключ API с доступом route и привяжите его к проекту. Передавайте его со своего сервера как токен Bearer.
- Используйте единые единицы измерения в JSON. Укажите проём, внутренние размеры и грузоподъёмность, затем добавьте размеры, массу, количество, ориентации и точки доставки грузов.
- До отправки задайте Idempotency-Key. Сохраните ID задания из ответа 202. Если ответ потерян, повторите тот же запрос с тем же ключом. При проверке статуса учитывайте Retry-After.
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{
"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
}{
"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
}Прочитать результат
Завершённое задание возвращает проверенную раскладку, доказательство невозможности, отсутствие найденного плана или предел поиска. Частичное размещение требует явного согласия.
Проверяйте поля result.status и billing.status отдельно. Завершённое задание может не содержать пригодной схемы. Если разрешено частичное размещение, перед отправкой проверьте, что не вошло.
Проверяйте состояние через GET с полученным ID. Cancel запрашивает отмену ожидающей или выполняющейся задачи. DELETE удаляет сохранённый ввод и результат завершённой задачи.
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}/cancelDELETE /api/v1/load-plans/{id}
Для экспорта нужны проверенный план и разрешение. Рабочий лист выгружается в HTML, таблица — в CSV, 3D-модель — в GLB.
GET /api/v1/load-plans/{id}/worksheetGET /api/v1/load-plans/{id}/csv
Для новой версии завершённого задания отправьте обновлённый манифест с Revises-Load-Plan и новым ключом идемпотентности. Экспортируется последняя проверенная версия.
Расчёт использует указанные размеры и ограничения. Перед погрузкой проверьте с оператором фактические размеры, зазоры, крепление груза, допустимые нагрузки на оси и применимые правила.
Сравнение оборудования, автопарк и палеты
Сервер компании использует ключ проекта, проверяет цену и ставит подтверждённый запрос в очередь.
GET /api/v1/load-plans/pricesPOST /api/v1/load-plans/import-previewPOST /api/v1/load-plans/comparePOST /api/v1/load-plans/fleetPOST /api/v1/load-plans/palletizePOST /api/v1/load-plans/multi-stopPOST /api/v1/load-plans/bulkPOST /api/v1/load-plans/packagingPOST /api/v1/load-plans/dispatch· Сравнение машин и маршрутовPOST /api/v1/load-plans/fulfillment· Загрузка палет в машинуGET, POST /api/v1/load-plans/{id}/warehouse· Работа на складеPOST /api/v1/load-plans/simulation· Моделирование прошлых отправокGET /api/v1/load-plans/{id}/simulation-report· CSVGET /api/v1/load-plans/partner· Проект партнёраPOST /api/v1/load-plans/{id}/axle-estimateGET /api/v1/load-plans/webhook/eventsPOST /api/v1/load-plans/{id}/placement-previewPOST /api/v1/load-plans/{id}/placement-revisionsGET /api/v1/load-plans/{id}/pdfGET /api/v1/load-plans/{id}/xlsxPOST /api/v1/load-plans/{id}/shareGET /api/v1/load-plans/workspace/{kind}
Планирование упаковки
Передайте размеры и вес товаров заказа. Подберите коробку из каталога, рассчитайте размеры новой коробки или количество одинаковых товаров в ней.
Получите актуальные тарифы перед отправкой задания. Для модуля с отдельным тарифом передайте текущую цену в заголовке Confirm-Load-Credits. Цена null означает, что операция недоступна.
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{
"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
}
]
}Сравнение машин и маршрутов
Сравните одну машину и парк для одной отправки. Проверьте размещение, расстояние, время, стоимость по вашим тарифам и число машин. Маршруты зависят от покрытия Truck Routing.
Получите актуальные тарифы перед отправкой задания. Для модуля с отдельным тарифом передайте текущую цену в заголовке Confirm-Load-Credits. Цена null означает, что операция недоступна.
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{
"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
}
]
}
]
}Загрузка палет в машину
Разложите товары на палеты и погрузите палеты в машину. Просмотрите состав, 3D-сцену и порядок загрузки. Операторы сканируют штрихкоды и фиксируют отклонения по версии плана.
Получите актуальные тарифы перед отправкой задания. Для модуля с отдельным тарифом передайте текущую цену в заголовке Confirm-Load-Credits. Цена null означает, что операция недоступна.
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{
"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
{
"revision": 1,
"eventId": "scan-0001",
"unitId": "pallet-1:1"
}Моделирование прошлых отправок
Пересчитайте прошлые отправки с одним грузом в двух сценариях. Получите число машин, заполнение, неразмещённые единицы и разницу известных затрат в JSON и CSV.
Получите актуальные тарифы перед отправкой задания. Для модуля с отдельным тарифом передайте текущую цену в заголовке Confirm-Load-Credits. Цена null означает, что операция недоступна.
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{
"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
Проект партнёра
Используйте отдельный проект и ключ API для каждого клиента. Владелец задаёт месячный лимит кредитов, разрешённый HTTPS-источник и бренд в 3D-просмотрщике.
curl --fail -H "Authorization: Bearer $OSRM_API_KEY" https://osrmroute.com/api/v1/load-plans/partner{
"expiresInSeconds": 900,
"partnerEmbed": true
}Показ 3D-модели в вашем приложении
Проверенная сцена содержит грузовое пространство, проём, препятствия, координаты и размеры размещённых единиц с учётом ориентации в миллиметрах.
Проверьте порядок загрузки и разгрузки в 3D. Покажите проверенный план в TMS, WMS или портале через временный iframe либо откройте GLB в своём просмотрщике.
Скачайте последний проверенный план в формате GLB на свой сервер. Экспорт не требует дополнительных кредитов.
curl --fail -H "Authorization: Bearer $OSRM_API_KEY" \
"https://osrmroute.com/api/v1/load-plans/$JOB_ID/model" -o load-plan.glbАдрес /internal в примере обозначает маршрут вашего приложения с проверкой доступа. Храните API-ключ OSRMRoute на сервере.
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);{
"expiresInSeconds": 900,
"embedOrigin": "https://warehouse.example.com"
}<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>