The OptimoRoute web service API can be used to integrate ecommerce platforms, accounting software, and other business software with OptimoRoute and automate tasks such as importing orders, starting the optimization, and getting the information about planned routes from OptimoRoute. This article gives a quick overview of what to expect when using the API.
| Who can use this feature | |
| Available for all plans | |
| Users that have administrator privileges | |
| All regions | |
Web service API
Use the OptimoRoute Web Service Application Programming Interface (API) to connect OptimoRoute with ecommerce platforms, accounting software, and other business tools.
The API can automate tasks such as:
- Creating, updating, or deleting orders
- Starting route optimization
- Retrieving planned route and schedule information
- Updating driver settings, such as working hours, assigned vehicles, and start and end locations
- Receiving live tracking events after routes are sent to drivers
- Retrieving order completion details, including available proof of delivery data
- Sending order status and driver location updates from your own mobile app
Read the API documentation here.
Creating an authentication key
An authentication key is required for using OptimoRoute web service API.
To generate your authentication key:
- Go to Administration→Settings→Account→WS API
- Click the box to enable the API
Your unique key will be generated.
| You can only create one key. Disabling or regenerating the API key will cause any existing integrations to be disconnected. |