Skip to main content
OptimoRoute logo
  • Category: project management
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 17
  • Triggers: 0
  • Slug: OPTIMOROUTE
  • Version: 20261101_00

Tools

Slug: OPTIMOROUTE_CREATE_ORDERTool 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.

Input Parameters

string
Unique OptimoRoute-assigned order identifier. Used for UPDATE operations
string
required
Order date in YYYY-MM-DD format
number
Load requirement 1
number
Load requirement 2
number
Load requirement 3
number
Load requirement 4
string
Service notes
array
Required driver skills
string
User-specified order identifier. Required unless using ‘id’ parameter
number
Service completion time in minutes
object
required
Delivery/service location information
string
Priority level: L (low), M (medium), H (high), or C (critical). Default: M
string
required
Specifies action - CREATE, UPDATE, SYNC, or MERGE
string
required
Order type - D (delivery), P (pickup), or T (task)
array
Array of time window objects
string
Legacy custom field value 1
string
Legacy custom field value 2
string
Legacy custom field value 3
string
Legacy custom field value 4
string
Legacy custom field value 5
object
Custom fields object with flexible data types
array
Required vehicle features
boolean
Allow duplicate orderNo if true

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPTIMOROUTE_CREATE_OR_UPDATE_ORDERSTool 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.

Input Parameters

array
required
Array of orders to create or update. Maximum 500 orders per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPTIMOROUTE_DELETE_ORDERTool to remove a single order from the OptimoRoute system. Use when you need to delete a specific order by its orderNo.

Input Parameters

string
required
The user-specified identifier of the order to be deleted
boolean
If true, typical restrictions on removing orders from active plans are bypassed. Defaults to false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

array
required
List of orders to delete (max 500 per request). Each order must have either orderNo or id.
boolean
If true, ignores restrictions on deleting orders from live plans. Default: false.
boolean
If true, deletes all matches when multiple orders share the same identifier. Default: false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPTIMOROUTE_GET_COMPLETION_DETAILSRetrieve completion status, service timing and available completion notes for up to 500 orders.

Input Parameters

array
required
List of order identifiers to retrieve completion details for. Maximum 500 orders per request. Each order must contain either orderNo or id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPTIMOROUTE_GET_DRIVERSTool to retrieve all drivers in the system. Use when you need up-to-date driver data including status and contact information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPTIMOROUTE_GET_ORDERSRetrieve one or more orders by identifier, including available location and driver assignment details.

Input Parameters

array
required
List of order identifier objects (max 500). Each object must contain either ‘orderNo’ or ‘id’ field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPTIMOROUTE_GET_PLANNING_STATUSTool 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.

Input Parameters

integer
required
The ID of the planning process whose status you want to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPTIMOROUTE_GET_ROUTESRetrieve planned routes for a date, optionally filtered by driver or vehicle, with route parameters and stops.

Input Parameters

string
required
Date for which to retrieve routes in YYYY-MM-DD format
string
Filter results by driver’s serial number
string
Filter results by driver’s external identifier
string
Filter results by vehicle registration
boolean
Include encoded route polyline for map display
boolean
Include route’s start and end locations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPTIMOROUTE_GET_SCHEDULING_INFOTool 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.

Input Parameters

string
The unique OptimoRoute-assigned order identifier. Either orderNo or id must be provided.
string
The user-specified order identifier. Either orderNo or id must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

integer
Maximum number of orders to return per request. Use with after_tag for paginated retrieval.
array
List of order identifier objects to search for. Each object can contain either ‘orderNo’ or ‘id’ field.
string
Cursor for pagination. Pass the ‘afterTag’ value from a previous response to retrieve the next page of results.
object
Date range criteria for searching orders.
array
Filter by order status values (e.g., ‘failed’, ‘rejected’)
boolean
When true, includes full order data in the response. Default: false.
boolean
When true, includes scheduling information in the response. Default: false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
Target date for planning in YYYY-MM-DD format. Required if dateRange is not specified
string ("NONE" | "ROUTES" | "RESOURCES")
Constrains route modifications - NONE (no constraints), ROUTES (lock routes), or RESOURCES (lock resources). Default: NONE. Only applicable when startWith is CURRENT
string ("WT" | "NUM")
Balancing criteria - WT (working time) or NUM (order count). Default: WT
string ("OFF" | "ON" | "ON_FORCE")
Route balancing mode - OFF (no balancing), ON (balanced routes), or ON_FORCE (force balancing). Default: OFF
object
Date range for weekly planning.
string ("EMPTY" | "CURRENT")
EMPTY starts fresh planning, CURRENT uses existing routes. Default: EMPTY
array
Deprecated - use useOrderObjects instead. List of order identifiers
boolean
Minimizes route overlap when enabled. Default: false
boolean
Enables warehouse reload scheduling. Default: false
array
Selected drivers to include in planning. Empty array uses all available drivers
number
Weighting for balanced routes, range 0.0-1.0. Default: 0.3
array
Orders to optimize (maximum 500 orders per request). Each object contains either orderNo or id. Empty includes all valid orders
integer
Reload time at depot in minutes. Default: 0
boolean
Determines handling of pre-scheduled orders. Default: true

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPTIMOROUTE_STOP_PLANNINGTool to stop an active planning/optimization process. Use when you need to halt a running planning job by providing its ID.

Input Parameters

integer
required
The ID of the planning process to be stopped

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPTIMOROUTE_UPDATE_DRIVER_PARAMETERSUpdate a driver’s availability, work times, vehicle assignment, capacities or start/end locations. Existing routes for the driver on the specified date are unscheduled; changed start/end locations apply to all future optimizations.

Input Parameters

string
required
Target date in YYYY-MM-DD format
boolean
Enable or disable driver for the specified date
string
Ending location display address
string
required
Driver’s external identifier from driver administration
string
End of work shift in HH:MM 24-hour format
number
Ending location latitude coordinate
number
Ending location longitude coordinate
string
Starting location display address
string
Start of work shift in HH:MM 24-hour format
number
Starting location latitude coordinate
number
Starting location longitude coordinate
string
Vehicle external identifier to assign
integer
Load capacity limit for dimension 1
integer
Load capacity limit for dimension 2
integer
Load capacity limit for dimension 3
integer
Load capacity limit for dimension 4

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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.

Input Parameters

array
required
Array of driver parameter update objects (max 500)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not