Yük planlaması API-si və 3D inteqrasiya təlimatı
REST API ilə yük siyahısını göndərin, yerləşdirmə və yükləmə addımlarını alın, yoxlanmış 3D modeli öz tətbiqinizdə göstərin.
3D yük planlaması tarifləri
Hər əməliyyatın satın alınmış kreditlərlə yekun qiyməti var. Yoxlanmış tam plan və ya əvvəlcədən icazə verilmiş qismən plan əməliyyatın qaydalarına uyğun ödənişlidir. Ödənişə uyğun nəticə alınmadıqda rezerv qaytarılır.
| Modul | Əməliyyat başına kredit |
|---|---|
Standart yük planıPOST /api/v1/load-plans | 30 kredit |
Əl ilə yerləşdirmə düzəlişiPOST /api/v1/load-plans/{id}/placement-revisions | 5 kredit |
Palet planıPOST /api/v1/load-plans/palletize | 30 kredit |
Avadanlıq müqayisəsiPOST /api/v1/load-plans/compare | 40 kredit |
Çoxdayanacaqlı planPOST /api/v1/load-plans/multi-stop | 50 kredit |
Böyük yük siyahısıHər plan üçün 129–256 yük vahidiPOST /api/v1/load-plans/bulk | 50 kredit |
Çox maşına bölgüPOST /api/v1/load-plans/fleet | 70 kredit |
Maşın və marşrut müqayisəsiPOST /api/v1/load-plans/dispatch | 100 kredit |
Paletdən maşına yükləməPOST /api/v1/load-plans/fulfillment | 60 kredit |
Tarixi göndəriş simulyasiyasıPOST /api/v1/load-plans/simulation | 200 kredit |
Qutu planlamasıPOST /api/v1/load-plans/packaging | 30 kredit |
Yerləşdirmənin önizləməsinə və yoxlanmış nəticənin ixracına əlavə kredit tutulmur. Yoxlanmış yeni yerləşdirmə reviziyasının ayrıca tarifi var.
İşi göndərməzdən əvvəl canlı qiymət cavabını oxuyun. Ayrıca tarifli modulun cari qiymətini Confirm-Load-Credits başlığında göndərin. Null qiymət əməliyyatın əlçatan olmadığını göstərir.
curl --fail -H "Authorization: Bearer $OSRM_API_KEY" https://osrmroute.com/api/v1/load-plans/pricesSintetik iş göndərin
- Layihəyə bağlı və route səlahiyyətli canlı API açarı yaradın. Açarı serverinizdən Bearer token kimi göndərin.
- JSON yük siyahısında vahidləri eyni saxlayın. Avadanlığın girişini, daxili ölçülərini və faydalı yük həddini, sonra yükün ölçü, çəki, say, istiqamət və dayanacaqlarını göstərin.
- Göndərməzdən əvvəl Idempotency-Key təyin edin. 202 cavabındakı iş ID-sini saxlayın. Cavab itərsə, eyni sorğunu eyni açarla təkrarlayın. Status yoxlamalarında Retry-After göstərişini izləyin.
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
}Nəticəni oxuyun
Tamamlanmış işdə yoxlanmış yerləşdirmə, sübutlu sığmama, plan tapılmaması və ya axtarış həddi qaytarıla bilər. Qismən yerləşdirmə açıq razılıq tələb edir.
result.status və billing.status sahələrini ayrı yoxlayın. İş tamamlansa da, istifadəyə yararlı yerləşdirmə alınmaya bilər. Qismən plana icazə vermisinizsə, göndərişdən əvvəl sığmayan vahidlərə baxın.
Cavabda alınan iş ID-si ilə GET sorğusu göndərib vəziyyəti izləyin. Cancel növbədəki və ya işləyən işi dayandırmaq üçün sorğu göndərir. DELETE yekun vəziyyətdəki işin saxlanmış giriş və nəticəsini silir.
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}
İxrac üçün yoxlanmış plan və ixrac icazəsi tələb olunur. İş vərəqi HTML, cədvəl CSV, 3D model isə GLB formatında endirilir.
GET /api/v1/load-plans/{id}/worksheetGET /api/v1/load-plans/{id}/csv
Terminal işi yeniləmək üçün dəyişmiş manifesti Revises-Load-Plan başlığı və yeni idempotentlik açarı ilə göndərin. İxrac ən son yoxlanmış reviziya üçün açıqdır.
Hesablama təqdim etdiyiniz ölçü və məhdudiyyətlərə əsaslanır. Yükləmədən əvvəl faktiki ölçüləri, keçid boşluğunu, yükün bərkidilməsini, ox hədlərini və tətbiq olunan qaydaları operatorla yoxlayın.
Avadanlıq müqayisəsi, bölgü və palet
Şirkət serveri layihə açarından istifadə edir, cari tarifi oxuyur və təsdiqlənmiş sorğunu növbəyə göndərir.
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· Maşın və marşrut müqayisəsiPOST /api/v1/load-plans/fulfillment· Paletdən maşına yükləməGET, POST /api/v1/load-plans/{id}/warehouse· Anbar icrasıPOST /api/v1/load-plans/simulation· Tarixi göndəriş simulyasiyasıGET /api/v1/load-plans/{id}/simulation-report· CSVGET /api/v1/load-plans/partner· Tərəfdaş layihəsiPOST /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}
Qutu planlaması
Sifarişdəki məhsulların ölçü və çəkisini göndərin. Kataloqdan uyğun qutunu seçin, yeni qutu ölçüsü hesablayın və ya bir qutuya eyni məhsuldan neçə ədəd yerləşdiyini görün.
İşi göndərməzdən əvvəl canlı qiymət cavabını oxuyun. Ayrıca tarifli modulun cari qiymətini Confirm-Load-Credits başlığında göndərin. Null qiymət əməliyyatın əlçatan olmadığını göstərir.
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
}
]
}Maşın və marşrut müqayisəsi
Eyni göndəriş üçün bir maşını və ya bir neçə maşınlı parkı müqayisə edin. Yükün yerləşməsinə, məsafə və vaxta, təqdim etdiyiniz tarif üzrə xərcə və lazım olan maşın sayına baxın. Marşrut nəticəsi Truck Routing əhatəsindən asılıdır.
İşi göndərməzdən əvvəl canlı qiymət cavabını oxuyun. Ayrıca tarifli modulun cari qiymətini Confirm-Load-Credits başlığında göndərin. Null qiymət əməliyyatın əlçatan olmadığını göstərir.
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
}
]
}
]
}Paletdən maşına yükləmə
Məhsulları paletlərə, paletləri maşına yerləşdirin. Hər paletin tərkibini, 3D səhnəni və yükləmə sırasını görün. Operator barkodu skan edə və uyğunsuzluğu konkret plan reviziyasında qeyd edə bilər.
İşi göndərməzdən əvvəl canlı qiymət cavabını oxuyun. Ayrıca tarifli modulun cari qiymətini Confirm-Load-Credits başlığında göndərin. Null qiymət əməliyyatın əlçatan olmadığını göstərir.
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"
}Tarixi göndəriş simulyasiyası
Keçmiş göndərişləri eyni yüklə iki fərqli ssenaridə yenidən hesablayın. Maşın sayı, doluluq, yerləşməyən vahidlər və məlum tariflər üzrə xərc fərqini JSON və CSV-də alın.
İşi göndərməzdən əvvəl canlı qiymət cavabını oxuyun. Ayrıca tarifli modulun cari qiymətini Confirm-Load-Credits başlığında göndərin. Null qiymət əməliyyatın əlçatan olmadığını göstərir.
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
Tərəfdaş layihəsi
Hər müştəri üçün ayrıca layihə və API açarı saxlayın. Layihə üzrə aylıq kredit limitini, icazəli HTTPS domenini və 3D görüntüdə göstərilən brendi hesab sahibi təyin edir.
curl --fail -H "Authorization: Bearer $OSRM_API_KEY" https://osrmroute.com/api/v1/load-plans/partner{
"expiresInSeconds": 900,
"partnerEmbed": true
}3D modeli öz sisteminizdə göstərin
Yoxlanmış 3D səhnə daxili yük sahəsini, girişi, maneələri, yerləşdirilən vahidlərin koordinatlarını və istiqamətə uyğun ölçülərini millimetrlə verir.
Yükləmə və boşaltma sırasına 3D-də baxın. TMS, WMS və ya müştəri portalınızda yoxlanmış planı müddətli iframe ilə göstərin və ya GLB-ni öz 3D görüntüləyicinizdə açın.
Son yoxlanmış planı GLB kimi serverinizdən yükləyin. Bu ixrac əlavə kredit tutmur.
curl --fail -H "Authorization: Bearer $OSRM_API_KEY" \
"https://osrmroute.com/api/v1/load-plans/$JOB_ID/model" -o load-plan.glbNümunədə /internal ünvanı sizin sisteminizdəki girişlə qorunan endpoint-dir. OSRMRoute API açarını serverdə saxlayın.
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>