OptimoRoute API
OptimoRoute is a cloud platform for automated delivery route planning and field service scheduling across mobile workforces. An unofficial API lets you programmatically pull orders, optimized routes, driver assignments, completion details, and proof-of-delivery data—and push updates like new orders, planning runs, and completion status back into OptimoRoute.
What is OptimoRoute?
OptimoRoute is a cloud-based platform that automates delivery route planning and field service scheduling for mobile workforces. Customers import orders, automatically generate optimized routes and schedules, dispatch detailed routes to drivers' mobile phones, track driver locations and delivery progress in real time, send automated ETA and status updates to customers, capture digital signatures and photos as proof of delivery, and analyze performance metrics across delivery, logistics, field service, and home-service operations.
Core product capabilities include:
- Automated route planning and optimization (multi-driver workload balancing, constraint management)
- Driver mobile app with navigation, order details, and barcode scanning
- Live tracking, ETA management, and real-time drag-and-drop route modification
- Customer notifications via SMS and email
- Proof-of-delivery capture (signatures, photos) and customer feedback collection
- Truck and hazmat routing optimization with commercial truck GPS navigation
- Analytics and performance reporting
Common data entities:
- Orders, Stops, Time Windows, Service Times, Load/Capacity Constraints
- Routes, Scheduling Info, Planning Runs, Planning Status
- Drivers, Vehicles, Driver Positions, Skills/Parameters
- Events, Completion Details, Proof of Delivery (signatures, photos), Feedback
The OptimoRoute Integration Challenge
OptimoRoute publishes a web-service API, but operationalizing it for resilient, headless automation across a live dispatch operation has real friction:
- Concurrency caps: Accounts and IPs are limited to 5 concurrent web-service API requests, so high-volume sync must be carefully queued and throttled
- Long-running planning jobs: start_planning is asynchronous—integrations must poll get_planning_status and reconcile results rather than expecting a synchronous response
- Mobile-captured data: Proof-of-delivery photos, signatures, and completion timestamps originate in the driver app and surface only through completion endpoints, complicating real-time pulls
- Bulk-payload limits: Bulk order operations cap at 500 items per request, requiring chunking and idempotent retries for large fleets
- Key-based auth in query strings: API keys passed as query parameters must be rotated and secured carefully to avoid leakage in logs and proxies
- Coverage gaps: Some configuration and analytics views available in the web app are not fully exposed over the web-service API, leaving portal-only data behind
How Supergood Creates OptimoRoute APIs
Supergood combines OptimoRoute's web-service API with authenticated browser flows to deliver a resilient, normalized API layer for your account—covering orders, routes, drivers, and completion data even where the public surface is thin.
- Manages API keys and authenticated sessions securely with credential rotation
- Queues and throttles within the 5-concurrent-request limit, with backoff and chunking for 500-item bulk caps
- Polls asynchronous planning jobs and reconciles routes, scheduling info, and completion details into consistent objects
- Normalizes orders, routes, driver positions, and proof-of-delivery data so you integrate once and rely on stable schemas
Use OptimoRoute with AI agents: OptimoRoute MCP Server →
Getting Started
- Schedule Integration Assessment
Book a 30-minute session to confirm your account configuration, order volume, and authentication model.
- Supergood Generates and Validates Your API
We deliver a production-ready OptimoRoute adapter tailored to your routing, dispatch, and completion workflows.
- Deploy with Monitoring
Go live with continuous monitoring and automatic adaptation as OptimoRoute evolves.
API Endpoints
Authentication
/authenticateAuthenticate to an OptimoRoute account using the account's web-service API key and establish a session for downstream calls.
Orders
/ordersRetrieve orders and stops with their addresses, time windows, service times, and current scheduling status.
Orders
/create_or_update_ordersCreate or bulk-update orders (up to 500 per request) with locations, constraints, and delivery details.
Routing
/routesPull optimized routes and scheduling info, including stop sequence, assigned drivers, and planned ETAs.
Planning
/start_planningTrigger an asynchronous planning run to optimize routes across drivers; poll planning status for completion.
Completion
/completion_detailsRetrieve completion details, events, and proof-of-delivery data (signatures, photos, timestamps) captured in the driver app.
Use Cases
Sync orders and optimized routes into your stack
- Push new and updated orders into OptimoRoute in bulk with time windows and constraints - Pull optimized routes, stop sequences, and planned ETAs into dispatch and ops dashboards - Reconcile driver assignments and scheduling info across daily planning runs
Automate proof-of-delivery and completion capture
- Stream completion details, signatures, and photos from the driver app into your order or WMS system - Trigger downstream invoicing or customer-confirmation flows on delivery completion - Surface failed or exception stops for follow-up and rescheduling
Power real-time tracking and customer notifications
- Pull live driver positions and ETAs to feed branded tracking pages - Trigger SMS and email status updates from your own messaging stack - Reconcile actual vs. planned ETAs to monitor on-time performance
Drive analytics and route performance reporting
- Extract completed-route metrics, service times, and feedback into a warehouse - Compare planned vs. actual durations to tune routing constraints - Build cross-account KPI reporting across delivery and field-service operations
Technical Specifications
Authentication
Account web-service API key managed in a secure credential vault with rotation
Connectivity
OptimoRoute web-service API (REST/JSON over HTTPS) plus authenticated browser flows for portal-only data
Response format
Normalized JSON across Orders, Routes, Drivers, and Completion objects
Rate limits
Adaptive queuing within OptimoRoute's 5-concurrent-request cap per account/IP and 500-item bulk limits
Session management
Automated key handling, request queuing, and credential rotation
Data freshness
Near real-time pulls for orders, routes, and completion events with optional scheduled batch syncs
Security
Encrypted credential vault, scoped access, SOC 2-aligned controls, and audit logging
Webhooks
Event-style callbacks for order updates, planning completion, and delivery/completion status changes
Latency
Sub-second reads on cached entities; multi-second waits while asynchronous planning jobs run
Throughput
Horizontally scaled workers chunking bulk operations within the 500-item-per-request limit
Reliability
Retry, backoff, and idempotency keys for order writes and planning runs
Adaptation
Continuous monitoring of OptimoRoute API and web-app changes with automatic adapter updates
Frequently asked questions
Yes—OptimoRoute publishes a web-service REST/JSON API for orders, routes, drivers, and completion data. Supergood layers on top of it (and authenticated browser flows where needed) to deliver normalized, resilient endpoints and to cover data the public API doesn't fully expose.
Supergood queues and throttles all calls within OptimoRoute's per-account and per-IP concurrency cap, with backoff and chunking for bulk operations, so you get reliable sync without tripping rate limits.
Yes. Completion details, signatures, photos, and timestamps captured in the driver mobile app are surfaced through the completion endpoints and normalized into consistent objects for your downstream systems.
start_planning is asynchronous, so Supergood triggers the run, polls planning status, and reconciles the resulting routes and scheduling info into a single consistent response rather than leaving you to manage the polling loop.
OptimoRoute keys are stored in an encrypted credential vault, passed over HTTPS only, scoped per integration, and rotated—never exposed in your own application logs or query strings.