# OptimoRoute

OptimoRoute is an online route optimization and planning solution for delivery, logistics, and field service companies.

- **Category:** project management
- **Auth:** API_KEY
- **Tools:** 17
- **Triggers:** 0
- **Slug:** `OPTIMOROUTE`
- **Version:** 20260211_00

## Tools

### Create Order

**Slug:** `OPTIMOROUTE_CREATE_ORDER`

Tool to create a new order or update an existing order in OptimoRoute. Use when you need to add delivery, pickup, or task orders to the system with location, time windows, and other constraints.

### Create or Update Orders

**Slug:** `OPTIMOROUTE_CREATE_OR_UPDATE_ORDERS`

Tool to bulk create, update, or replace multiple orders at once without geocoding. Use when you need to add new orders or modify existing ones efficiently. Supports up to 500 orders per request.

### Delete All Orders

**Slug:** `OPTIMOROUTE_DELETE_ALL_ORDERS`

Tool to remove all orders and planned routes for a specified date. Use when you need to clear orders for a specific date or delete all orders system-wide if no date is provided.

### Delete Order

**Slug:** `OPTIMOROUTE_DELETE_ORDER`

Tool to remove a single order from the OptimoRoute system. Use when you need to delete a specific order by its orderNo.

### Delete Orders

**Slug:** `OPTIMOROUTE_DELETE_ORDERS`

Tool to delete one or more orders from the system in bulk (max 500 per request). Use when you need to remove orders, either individually or in batch operations.

### Get Order Completion Details

**Slug:** `OPTIMOROUTE_GET_COMPLETION_DETAILS`

Tool to retrieve completion details for one or more orders including proof of delivery data. Use when you need to check order completion status, timing details, and form data.

### Get Drivers

**Slug:** `OPTIMOROUTE_GET_DRIVERS`

Tool to retrieve all drivers in the system. Use when you need up-to-date driver data including status and contact information.

### Get Mobile Events

**Slug:** `OPTIMOROUTE_GET_EVENTS`

Tool to retrieve mobile events from drivers' field operations. Use when you need to track order completions, status changes (success, failed, on_duty, off_duty), and other field events for the currently active plan.

### Get Orders

**Slug:** `OPTIMOROUTE_GET_ORDERS`

Tool to retrieve one or more orders from OptimoRoute. Use when you need detailed order information including location, time windows, and assignment details.

### Get Planning Status

**Slug:** `OPTIMOROUTE_GET_PLANNING_STATUS`

Tool to retrieve the status of an active planning/optimization process. Use when you need to check the progress of a planning job by providing its ID.

### Get Planned Routes

**Slug:** `OPTIMOROUTE_GET_ROUTES`

Tool to retrieve all planned routes for a given date. Use when you need a detailed view of routes including optional stops, route parameters, and unassigned orders.

### Get Order Scheduling Info

**Slug:** `OPTIMOROUTE_GET_SCHEDULING_INFO`

Tool to retrieve scheduling information for a specific order. Use when you need to check if an order is scheduled and get details like driver assignment, timing, and position.

### Search Orders

**Slug:** `OPTIMOROUTE_SEARCH_ORDERS`

Tool to search for orders in OptimoRoute based on criteria. Use when you need to find orders by date range, order identifiers, or order status. At least one of 'orders' or 'date_range' must be provided.

### Start Planning

**Slug:** `OPTIMOROUTE_START_PLANNING`

Tool to start the planning/optimization process for a specified date or date range. Use when you need to generate optimized routes for orders and drivers. Requires orders to be created before planning can begin.

### Stop Planning

**Slug:** `OPTIMOROUTE_STOP_PLANNING`

Tool to stop an active planning/optimization process. Use when you need to halt a running planning job by providing its ID.

### Update Driver Parameters

**Slug:** `OPTIMOROUTE_UPDATE_DRIVER_PARAMETERS`

Tool to update driver parameters for a specific date including work times, vehicle assignment, and start/end locations. Use when you need to modify driver availability or routing constraints. Note that this unschedules existing routes for the driver on the specified date.

### Update Drivers Parameters

**Slug:** `OPTIMOROUTE_UPDATE_DRIVERS_PARAMETERS`

Tool to update parameters of multiple drivers for specified dates in bulk (max 500 per request). Use when you need to modify driver configuration including work hours, vehicle assignments, and location settings. Note: Existing routes for the specified drivers and dates will be unscheduled.
