rocketkind
Productivity

OptimoRoute

OptimoRoute plans delivery and field-service routes: you load orders and driver availability, it builds optimized routes, and drivers work them in its mobile app.

Authentication

  • API key

Actions

Generic API request. Call any OptimoRoute API endpoint on this connection, for the case where no shipped action covers it yet. The connection supplies the base URL, the authentication and the egress route, so only the path, query and body are yours to fill.

  • Create or update ordersCreate, update or replace up to 500 orders in one call.
  • Create orderCreate a delivery, pickup or task order in OptimoRoute, or update one, choosing the behaviour with operation.
  • Delete orderDestructivePermanently remove one order from OptimoRoute by its order number.
  • Get completion detailsRead how up to 500 orders were completed: status (success, failed, rejected, …), service start and end time and position, proof-of-delivery form data (notes, signature and photo links, scanned barcodes), the tracking page link and optionally customer feedback.
  • Get eventsRead driver mobile-app events on the live routes — onduty, offduty, startroute, endroute, startservice, success, failed, rejected, starttimechanged — with time, driver, order and position.
  • Get ordersFetch the full stored data of up to 500 known orders by order number or OptimoRoute id — date, type, location, time windows, assigned driver, loads and contact fields.
  • Get planning statusReport the progress of a planning job started with optimoroute:startplanning: its status and percentage complete.
  • Get routesRead the planned routes for a date: per driver and vehicle, the ordered stops with order number, id, scheduled time, address and coordinates, plus route duration, distance and loads.
  • Get scheduling infoTell whether one order is scheduled and, if so, on which driver and vehicle, at which stop number and planned arrival time, with a live arrival estimate once the route is under way.
  • Search ordersFind orders by date range (up to 35 days) and status, or look up a list of known orders, and optionally include each order's data and its schedule (driver, stop number, planned arrival).
  • Start planningDestructiveStart OptimoRoute's route optimization for a date (or a date range, where the plan supports weekly planning), optionally limited to chosen drivers and orders and with balancing, clustering and depot-visit settings.
  • Stop planningDestructiveStop a running planning job started with optimoroute:startplanning, for example when it runs past a deadline or was started with the wrong settings.
  • Update driver parametersDestructiveChange one driver's settings for a single date before planning: enable or disable them, set working hours, assign a vehicle, override vehicle capacities, or move their start and end location.

Product names, logos and brands are the property of their respective owners and are used here for identification only. Their use does not imply endorsement by, or affiliation with, those owners.