OptimoRoute
ProductivityAPI key
Create and track delivery and service orders, plan and read optimized routes, and follow driver events in OptimoRoute.
12 actions
| Action | Effect | Data handled | Scope |
|---|---|---|---|
| optimoroute_create_orderCreates, updates or syncs a delivery, pickup or task order with its location, time windows, duration, load and driver requirements | write | Personal data | |
| optimoroute_get_ordersReturns up to 500 orders by order number or id | read | Personal data | |
| optimoroute_search_ordersFinds orders in a date range of up to 35 days or by number, optionally by status, with order data and schedule information; after_tag in the response gets the next page | read | Personal data | |
| optimoroute_delete_orderDeletes an order by its number; forceDelete also removes it from a live route | destructive | General | |
| optimoroute_get_routesReturns the planned routes of a date with their drivers, vehicles and ordered stops, optionally for one driver or vehicle | read | Personal data | |
| optimoroute_get_scheduling_infoReturns whether an order is scheduled and, if so, its driver, stop number, scheduled time and live ETA | read | General | |
| optimoroute_start_planningStarts route optimization for a date or date range, with optional balancing and starting from the current routes; returns a planningId | write | General | |
| optimoroute_get_planning_statusReturns the status (N new, R running, C cancelled, F finished, E error) and percentage of a planning run | read | General | |
| optimoroute_stop_planningStops a running planning run | write | General | |
| optimoroute_get_completion_detailsReturns the completion status, times, proof-of-delivery form data and tracking URL of up to 500 orders | read | Personal data | |
| optimoroute_get_eventsReturns drivers' mobile events, such as start and end of routes and service, successes and failures, since the tag of a previous call | read | Personal data | |
| optimoroute_update_driver_parametersEnables or disables a driver for a date or changes their work hours or vehicle; existing routes of that driver and date are unscheduled | write | General |