- Category: project management
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 17
- Triggers: 0
- Slug:
OPTIMOROUTE - Version: 20261101_00
Tools
Create Order
Create Order
Create or Update Orders
Create or Update Orders
Delete All Orders
Delete All Orders
Slug:
OPTIMOROUTE_DELETE_ALL_ORDERSTool 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.Input Parameters
Optional date for which to remove orders and routes in YYYY-MM-DD format. If not provided, all orders system-wide will be deleted.
Output
Delete Order
Delete Order
Delete Orders
Delete Orders
Slug:
OPTIMOROUTE_DELETE_ORDERSTool 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.Input Parameters
List of orders to delete (max 500 per request). Each order must have either orderNo or id.
Output
Get Order Completion Details
Get Order Completion Details
Get Drivers
Get Drivers
Get Mobile Events
Get Mobile Events
Slug:
OPTIMOROUTE_GET_EVENTSTool 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.Input Parameters
Marker for a prior point in time. Submit this value to retrieve only events occurring after the previous call. Leave empty for initial requests to get all events.
Output
Get Orders
Get Orders
Get Planning Status
Get Planning Status
Get Planned Routes
Get Planned Routes
Get Order Scheduling Info
Get Order Scheduling Info
Search Orders
Search Orders
Slug:
OPTIMOROUTE_SEARCH_ORDERSSearch OptimoRoute orders by order identifiers or a date range, optionally filtering by status. At least one of identifiers or a date range is required; date ranges can span at most 35 days. Request order data or scheduling information as needed; the provider returns up to 500 orders per page.Input Parameters
List of order identifier objects to search for. Each object can contain either ‘orderNo’ or ‘id’ field.
Cursor for pagination. Pass the ‘afterTag’ value from a previous response to retrieve the next page of results.
Output
Start Planning
Start Planning
Slug:
OPTIMOROUTE_START_PLANNINGTool 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.Input Parameters
Constrains route modifications - NONE (no constraints), ROUTES (lock routes), or RESOURCES (lock resources). Default: NONE. Only applicable when startWith is CURRENT
Route balancing mode - OFF (no balancing), ON (balanced routes), or ON_FORCE (force balancing). Default: OFF
EMPTY starts fresh planning, CURRENT uses existing routes. Default: EMPTY
Orders to optimize (maximum 500 orders per request). Each object contains either orderNo or id. Empty includes all valid orders
Output
Stop Planning
Stop Planning
Update Driver Parameters
Update Driver Parameters
Update Drivers Parameters
Update Drivers Parameters
Slug:
OPTIMOROUTE_UPDATE_DRIVERS_PARAMETERSUpdate driver parameters for specified dates in bulk, including work hours, vehicle assignments and locations; existing routes for those drivers and dates are unscheduled. Provider responses may fail validation after updates are submitted.