API Sources

Live operational snapshot — orders, fleet, and the most recent planning run.

📈 Order Intake — Last 7 Days
🗺️ Last Planning Run
🚚 Dispatch Overview

Connect Dispatch Planner to your order management system via HTTP APIs. Configure authentication, map response fields, and test before activating.

Generate API keys to allow 3rd-party systems to push orders directly into Dispatch Planner.

🔑 API Keys
NameKey (masked)CreatedLast Used
Loading…
📖 API Reference
Base URL
Authentication

Include your API key in every request header:

X-API-Key: dp_your_key_here
POST /api/v1/orders — Submit orders
{
  "orders": [
    {
      "order_no": "SO-1001",
      "customer_code": "CUST-01",
      "customer_name": "ABC Store",
      "lat": 25.2048,
      "lng": 55.2708,
      "delivery_slot": "Morning",
      "slot_start": "08:00",
      "slot_end": "12:00",
      "service_time": 20,
      "weight_kg": 150.5,
      "notes": "Call before delivery",
      "lines": [
        {
          "item_code": "ITEM-001",
          "description": "Mineral Water 500ml",
          "qty": 100,
          "uom": "EA",
          "weight_kg": 50.0,
          "pallets": 0.5
        }
      ]
    }
  ]
}
GET /api/v1/orders — List orders in queue
curl -H "X-API-Key: dp_..." http://HOST/api/v1/orders
DELETE /api/v1/orders — Clear queue
curl -X DELETE -H "X-API-Key: dp_..." http://HOST/api/v1/orders
🧪 Quick Test
0 vehicles
·
0 customers
·

🎲 Test Data Generators

Quickly populate master data and orders with plausible random values for testing — pick just the fields you need.

🎲 Order Simulation

Random test orders from active customers/items — 1–5 line items each. Shows up on the Orders page.

🧬 Customer Fields

Zone/Area, Slot, Gatepass, Service Duration, Priority Delivery, Permit Area.

🚛 Vehicle Fields

Vehicle Type, Permit Area, Priority Delivery, Work Start/End Time, Max Route Distance, Avg Speed, Weight & CBM Capacity (CBM derived from weight).

🏷️ Item Fields

UOM, Weight, Units per Carton, Carton Dimensions.

📦 Carton Fields

Dimensions (CBM computed automatically), Weight, Units per Carton.

🕒 Delivery History

Random past-delivery records (date range + service duration) so the planner has real history to learn each customer's average service time from.

🗑 Clear Dispatched Orders

Deletes all dispatched routes/orders and reverts their source orders back to pending so they can be re-planned.

🗑 Clear All Orders

Deletes every order from the queue on the Orders page. This cannot be undone.

🧪 External SQL Server Sync

Pull master data from an external SQL Server for testing — write a query, map its columns to Dispatch Planner fields, and sync. Matching records update; new records insert.

0 configs
0 pending orders
🧮

No plan loaded

Run a plan from the Planner page to see results here.

Plan Date

Upload real past-delivery records (Order Number, Customer Code, Vehicle, Actual Delivery Time, Service Duration, Actual Delivery Geo Code). Whenever planning runs, a customer with at least one record here gets its real average service time used instead of the default estimate — customers with no history are unaffected.

Compares dispatched (planned) orders against uploaded real-world delivery outcomes, matched by order number. Orders with no actual-delivery record yet aren't shown — that's expected until Delivery History is updated for them.

–
📊 Matched Deliveries per Day — On-Time vs Late
On-time Late
📋 Matched Orders
Plan DateOrder NoCustomerPlate Planned TimeSlotActual Time Planned Svc (min)Actual Svc (min) Delay (min)Svc Variance (min)Status
Loading…
📍

Routes

Coming in the next sprint.

📋

History

Coming in the next sprint.

Configure integrations used by the planning engine.

🤖 AI Planning Assist

Lets a dispatcher give the planner a free-text instruction (via a local Gemma/Ollama model) to influence a run — e.g. excluding a vehicle or area. When turned off, the prompt box is hidden from the Run Planning dialog and no AI call is made, even if one was typed before.

🛣️ Routing Provider

Choose which service calculates real road distances/times for the planning engine. All three configs stay saved even when not the active provider, so you can switch anytime. Planning always uses real road distance — orders that can't get one (missing key/URL, API failure, group too large) are left unplanned rather than approximated with a straight line.

No API key needed — point this at your own OSRM instance. The public demo server (router.project-osrm.org) is rate-limited and not meant for production use.
🔑 DevExtreme License

Paste the runtime key produced by DevExpress's devextreme-license CLI tool (not your raw account key — that won't work and shouldn't be shared). Saving rewrites the license file on the server; reload the page afterward for it to take effect.

Manage your own login credentials.

🔒 Change Password

Create and manage user accounts. Only admins can sign users in — there is no public sign-up.

👤 Users
UsernameFull NameAdminStatusLast Login
Loading…

Login, logout, auto-login, and user-management activity. Newest first.

📜 Audit Log
–
TimeEventUserIP AddressDetails
Loading…

Order-processing counter for license reporting — one Save-as-Dispatched action counts every order in it.

📜 Dispatch History
TimePlanRoutesOrdersDispatched By
Loading…