Yük Planlama API’si ve 3D Entegrasyon Kılavuzu
REST API ile yük listesini gönderin, yerleşimi ve yükleme adımlarını alın, doğrulanmış 3D modeli kendi uygulamanızda gösterin.
3D Yük Planlama Fiyatları
Her işlemin satın alınmış kredilerle tek bir toplam fiyatı vardır. Doğrulanmış tam plan veya izin verilen kısmi plan, işlemin kurallarına göre ücretlendirilir. Ücretlendirilebilir sonuç çıkmazsa rezerv kaldırılır.
| Modül | İşlem başına kredi |
|---|---|
Standart yük planıPOST /api/v1/load-plans | 30 kredi |
Manuel yerleşim revizyonuPOST /api/v1/load-plans/{id}/placement-revisions | 5 kredi |
Palet planlamaPOST /api/v1/load-plans/palletize | 30 kredi |
Ekipman karşılaştırmasıPOST /api/v1/load-plans/compare | 40 kredi |
Çok duraklı yük planıPOST /api/v1/load-plans/multi-stop | 50 kredi |
Büyük yük listesiPlan başına 129–256 yük birimiPOST /api/v1/load-plans/bulk | 50 kredi |
Birden fazla araca dağıtımPOST /api/v1/load-plans/fleet | 70 kredi |
Araç ve rota karşılaştırmasıPOST /api/v1/load-plans/dispatch | 100 kredi |
Paletten araca yüklemePOST /api/v1/load-plans/fulfillment | 60 kredi |
Geçmiş gönderi simülasyonuPOST /api/v1/load-plans/simulation | 200 kredi |
Kutu planlamaPOST /api/v1/load-plans/packaging | 30 kredi |
Yerleşim önizlemesi ve doğrulanmış sonucun dışa aktarımı ek kredi gerektirmez. Doğrulanmış bir yerleşim revizyonunu kaydetmenin ayrı bir fiyatı vardır.
İsteği göndermeden önce güncel fiyat yanıtını okuyun. Ayrı fiyatlandırılan bir modül için mevcut kredi fiyatını Confirm-Load-Credits başlığında gönderin. Null fiyat, işlemin kullanılamadığını gösterir.
curl --fail -H "Authorization: Bearer $OSRM_API_KEY" https://osrmroute.com/api/v1/load-plans/pricesSentetik iş gönderin
- Projeye bağlı, route yetkili bir canlı API anahtarı oluşturun. Anahtarı sunucunuzdan Bearer token olarak gönderin.
- JSON yük listesinde tutarlı birim kullanın. Ekipmanın açıklığını, iç ölçülerini ve kapasitesini girin. Ardından yükün ölçüsünü, ağırlığını, adedini, yönlerini ve duraklarını ekleyin.
- Göndermeden önce Idempotency-Key belirleyin. 202 yanıtındaki iş kimliğini saklayın. Yanıt kaybolursa aynı isteği aynı anahtarla tekrarlayın. Durum sorgularında Retry-After değerine uyun.
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
}Sonucu okuyun
Tamamlanan işte doğrulanmış yerleşim, sığmama kanıtı, plan bulunamaması veya arama sınırı dönebilir. Kısmi yerleşim açık onay gerektirir.
result.status ve billing.status alanlarını ayrı kontrol edin. Tamamlanan iş kullanılabilir bir yerleşim içermeyebilir. Kısmi plana izin verdiyseniz sevk öncesinde sığmayan birimleri inceleyin.
Dönen iş kimliğiyle GET üzerinden durumu izleyin. Cancel sıradaki veya çalışan işin iptalini ister. DELETE son durumdaki işin saklanan girdisini ve sonucunu siler.
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}
Dışa aktarma için doğrulanmış plan ve izin gerekir. Çalışma sayfası HTML, tablo CSV, 3B model GLB olarak indirilir.
GET /api/v1/load-plans/{id}/worksheetGET /api/v1/load-plans/{id}/csv
Sonlanmış bir işi güncellemek için yeni manifesti Revises-Load-Plan ve yeni bir idempotans anahtarıyla gönderin. En son doğrulanmış revizyon dışa aktarılabilir.
Hesaplama, sağladığınız ölçüleri ve kısıtları kullanır. Yükleme öncesinde ekipman ölçülerini, manevra boşluğunu, sabitlemeyi, aks sınırlarını ve geçerli kuralları operatörle doğrulayın.
Ekipman karşılaştırması, filo ve palet
Şirket sunucusu proje anahtarını kullanır, güncel fiyatı okur ve onaylanan isteği kuyruğa alır.
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· Araç ve rota karşılaştırmasıPOST /api/v1/load-plans/fulfillment· Paletten araca yüklemeGET, POST /api/v1/load-plans/{id}/warehouse· Depo işlemleriPOST /api/v1/load-plans/simulation· Geçmiş gönderi simülasyonuGET /api/v1/load-plans/{id}/simulation-report· CSVGET /api/v1/load-plans/partner· İş ortağı projesiPOST /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}
Kutu planlama
Siparişteki ürünlerin ölçü ve ağırlıklarını gönderin. Katalogdan uygun kutuyu seçin, yeni kutu ölçüsü önerin veya kaç eş ürünün sığdığını hesaplayın.
İsteği göndermeden önce güncel fiyat yanıtını okuyun. Ayrı fiyatlandırılan bir modül için mevcut kredi fiyatını Confirm-Load-Credits başlığında gönderin. Null fiyat, işlemin kullanılamadığını gösterir.
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
}
]
}Araç ve rota karşılaştırması
Aynı gönderi için tek araç ve filo seçeneklerini karşılaştırın. Sığma, mesafe, süre, kendi tarifenize göre maliyet ve araç sayısını inceleyin. Rota, Truck Routing kapsamına bağlıdır.
İsteği göndermeden önce güncel fiyat yanıtını okuyun. Ayrı fiyatlandırılan bir modül için mevcut kredi fiyatını Confirm-Load-Credits başlığında gönderin. Null fiyat, işlemin kullanılamadığını gösterir.
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
}
]
}
]
}Paletten araca yükleme
Ürünleri paletlere, paletleri kamyona yerleştirin. Palet içeriğini, 3B sahneyi ve yükleme sırasını görün. Operatörler barkod okutup sorunları plan revizyonuna kaydedebilir.
İsteği göndermeden önce güncel fiyat yanıtını okuyun. Ayrı fiyatlandırılan bir modül için mevcut kredi fiyatını Confirm-Load-Credits başlığında gönderin. Null fiyat, işlemin kullanılamadığını gösterir.
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"
}Geçmiş gönderi simülasyonu
Geçmiş gönderileri aynı yükle iki senaryoda tekrar hesaplayın. Araç sayısını, doluluğu, yerleştirilemeyen birimleri ve bilinen maliyet farkını JSON ve CSV olarak alın.
İsteği göndermeden önce güncel fiyat yanıtını okuyun. Ayrı fiyatlandırılan bir modül için mevcut kredi fiyatını Confirm-Load-Credits başlığında gönderin. Null fiyat, işlemin kullanılamadığını gösterir.
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
İş ortağı projesi
Her müşteri için ayrı proje ve API anahtarı kullanın. Hesap sahibi aylık kredi sınırını, izinli HTTPS kaynağını ve 3B görünümde gösterilen markayı belirler.
curl --fail -H "Authorization: Bearer $OSRM_API_KEY" https://osrmroute.com/api/v1/load-plans/partner{
"expiresInSeconds": 900,
"partnerEmbed": true
}3B modeli kendi uygulamanızda gösterin
Doğrulanmış sahne, yük alanını, açıklığı, engelleri ve yerleştirilen birimlerin koordinatlarıyla yönlerine göre ölçülerini milimetre cinsinden verir.
Yükleme ve boşaltma sırasını 3B inceleyin. Doğrulanmış planı TMS, WMS veya müşteri portalınızda süreli iframe ile gösterin ya da GLB dosyasını kendi görüntüleyicinizde açın.
Son doğrulanmış planı sunucunuzdan GLB olarak indirin. Dışa aktarma ek kredi gerektirmez.
curl --fail -H "Authorization: Bearer $OSRM_API_KEY" \
"https://osrmroute.com/api/v1/load-plans/$JOB_ID/model" -o load-plan.glbAşağıdaki /internal adresi, uygulamanızdaki kimlik doğrulamalı rotayı temsil eder. OSRMRoute API anahtarını sunucunuzda saklayı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>