OptimoRoute MCP by usefulapi
Check OptimoRoute routes, orders and driver events, and create orders or start route planning.
Sollte ich dies verwenden
Qualität und Sicherheit
Befunde (7)
- LOWin optimoroute_get_scheduling_info
- LOWin optimoroute_get_completion_details
- LOWin optimoroute_get_planning_status
- LOWin optimoroute_get_dispatch_status
- LOWin optimoroute_create_or_update_orders
- LOWin optimoroute_update_driver_parameters
- LOWin optimoroute_update_completion_details
Basierend auf einer automatisierten Analyse der Tool-Definitionen und der Einhaltung des Protokolls.
Kontextkosten
Dies ist die ungefähre Anzahl der Tokens, die jedes Mal verbraucht werden, wenn die Tools des Servers in den Kontext eines Modells geladen werden. Höhere Werte verringern die Aufmerksamkeit, die für andere Aufgaben verfügbar ist.
Installieren
Installation mit einem Klick
Fügen Sie dies Ihrer Datei `claude_desktop_config.json` hinzu:
{
"mcpServers": {
"optimoroute": {
"url": "https://optimoroute.usefulapi.io/mcp"
}
}
}Remote-Endpunkte
https://optimoroute.usefulapi.io/mcpstreamable-httpWas es kann
Tool-Inventar
Tools (15)
🟢optimoroute_get_routes(date, driverSerial, driverExternalId, vehicleRegistration, includeRoutePolyline, ...)
Get the planned routes for one date: per driver/vehicle the duration, distance, loads and the ordered list of stops with scheduled times. Optionally filter to one driver or vehicle and include the encoded polyline, start/end locations and dispatch status. OptimoRoute: GET /get_routes.
Eingabe-Schema
{
"type": "object",
"properties": {
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Date in YYYY-MM-DD format, e.g. 2026-09-30."
},
"driverSerial": {
"description": "Only this driver's route (serial number).",
"type": "string"
},
"driverExternalId": {
"description": "Only this driver's route (external id).",
"type": "string"
},
"vehicleRegistration": {
"description": "Only this vehicle's route.",
"type": "string"
},
"includeRoutePolyline": {
"description": "Include the encoded route polyline (large).",
"type": "boolean"
},
"includeRouteStartEnd": {
"description": "Include each route's start and end locations.",
"type": "boolean"
},
"includeDispatchStatus": {
"description": "Include whether each route was sent to its driver, and changed since.",
"type": "boolean"
}
},
"required": [
"date"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢optimoroute_get_orders(orders)
Fetch full order data (location, time windows, assignment, loads, skills, contact) for up to 500 orders by orderNo or id. Each result has its own success flag; missing orders come back with ERR_ORD_NOT_FOUND rather than failing the call. Read-only despite using POST. OptimoRoute: POST /get_orders.
Eingabe-Schema
{
"type": "object",
"properties": {
"orders": {
"minItems": 1,
"maxItems": 500,
"type": "array",
"items": {
"type": "object",
"properties": {
"orderNo": {
"description": "The user-specified order number.",
"type": "string"
},
"id": {
"description": "OptimoRoute's unique order id.",
"type": "string"
}
}
},
"description": "Orders to target, each {\"orderNo\": \"...\"} or {\"id\": \"...\"}. At most 500."
}
},
"required": [
"orders"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢optimoroute_search_orders(dateRange, orders, orderStatus, includeOrderData, includeScheduleInformation, ...)
Find orders in a date range (at most 35 days) or by a list of orderNo/id, optionally filtered by status (e.g. failed, rejected, unscheduled), with order data and/or scheduling info. Up to 500 per page; pass the returned after_tag with the SAME other parameters to get the next page. Read-only despite using POST. OptimoRoute: POST /search_orders.
Eingabe-Schema
{
"type": "object",
"properties": {
"dateRange": {
"type": "object",
"properties": {
"from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Date in YYYY-MM-DD format, e.g. 2026-09-30."
},
"to": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Date in YYYY-MM-DD format, e.g. 2026-09-30."
}
},
"required": [
"from",
"to"
],
"description": "A date range, e.g. {\"from\": \"2026-09-28\", \"to\": \"2026-10-02\"}."
},
"orders": {
"minItems": 1,
"maxItems": 500,
"type": "array",
"items": {
"type": "object",
"properties": {
"orderNo": {
"description": "The user-specified order number.",
"type": "string"
},
"id": {
"description": "OptimoRoute's unique order id.",
"type": "string"
}
}
},
"description": "Orders to target, each {\"orderNo\": \"...\"} or {\"id\": \"...\"}. At most 500."
},
"orderStatus": {
"description": "Only orders in these statuses.",
"type": "array",
"items": {
"type": "string",
"enum": [
"unscheduled",
"scheduled",
"on_route",
"servicing",
"success",
"failed",
"rejected",
"cancelled"
]
}
},
"includeOrderData": {
"description": "Include each order's full data.",
"type": "boolean"
},
"includeScheduleInformation": {
"description": "Include each order's driver, stop number and scheduled time.",
"type": "boolean"
},
"after_tag": {
"description": "Cursor from the previous page's after_tag.",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢optimoroute_get_scheduling_info(orderNo, id)
Is this order scheduled, and if so on which driver/vehicle, at which stop number and time, plus the live ETA from the routes sent to drivers. Give orderNo or id. OptimoRoute: GET /get_scheduling_info.
Eingabe-Schema
{
"type": "object",
"properties": {
"orderNo": {
"description": "The user-specified order number.",
"type": "string"
},
"id": {
"description": "OptimoRoute's unique order id.",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢optimoroute_get_completion_details(orders, includeCustomerFeedback)
Get the completion status of up to 500 orders (unscheduled, scheduled, on_route, servicing, success, failed, rejected, cancelled) with service start/end times and positions, proof-of-delivery form data (notes, signature and photo URLs, barcodes), the tracking URL and optionally customer feedback. Read-only despite using POST. OptimoRoute: POST /get_completion_details.
Eingabe-Schema
{
"type": "object",
"properties": {
"orders": {
"minItems": 1,
"maxItems": 500,
"type": "array",
"items": {
"type": "object",
"properties": {
"orderNo": {
"description": "The user-specified order number.",
"type": "string"
},
"id": {
"description": "OptimoRoute's unique order id.",
"type": "string"
}
}
},
"description": "Orders to target, each {\"orderNo\": \"...\"} or {\"id\": \"...\"}. At most 500."
},
"includeCustomerFeedback": {
"description": "Include the customer's rating and comment, if customer feedback is configured.",
"type": "boolean"
}
},
"required": [
"orders"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢optimoroute_get_events(after_tag)
Read driver-app events for the live routes — on_duty, off_duty, start_route, end_route, start_service, success, failed, rejected, start_time_changed — up to 500 per call. Pass the returned tag as after_tag next time to get only newer events; remainingEvents says whether more are waiting. Events can arrive out of order when devices were offline. OptimoRoute: GET /get_events.
Eingabe-Schema
{
"type": "object",
"properties": {
"after_tag": {
"description": "The tag from a previous call; omit to read from the start.",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢optimoroute_get_planning_status(planningId)
Check a planning (route optimization) run started with optimoroute_start_planning: status N new, R running, C cancelled, F finished, E error, plus percentageComplete. OptimoRoute: GET /get_planning_status.
Eingabe-Schema
{
"type": "object",
"properties": {
"planningId": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The planningId returned by optimoroute_start_planning."
}
},
"required": [
"planningId"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢optimoroute_get_dispatch_status(date, includeRouteChanges)
Have the routes (and customer notifications) for a date been sent to drivers, when, and are they the live routes? Optionally counts routes added, modified or removed since sending. Omit date for the currently live date. OptimoRoute: GET /get_dispatch_status.
Eingabe-Schema
{
"type": "object",
"properties": {
"date": {
"description": "Date to check, YYYY-MM-DD. Omit for the live routes' date.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"includeRouteChanges": {
"description": "Include counts of routes changed since sending.",
"type": "boolean"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴optimoroute_create_order(operation, orderNo, id, date, type, ...)
Create one order, or update an existing one, with address geocoding. operation: CREATE (new; errors if orderNo exists), UPDATE (existing only), MERGE (create or update only the fields you send — safest for edits), SYNC (create or REPLACE all fields with what you send). CREATE/SYNC/MERGE of a new order need date, type, location and orderNo or id. A location is either an existing locationNo alone, an address to geocode, or latitude+longitude+locationName. OptimoRoute: POST /create_order.
Eingabe-Schema
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"MERGE",
"SYNC"
],
"description": "How to apply the order (see description)."
},
"orderNo": {
"description": "Your order number, shown in the web app. Used to match existing orders.",
"type": "string"
},
"id": {
"description": "OptimoRoute's order id. Takes priority over orderNo when matching.",
"type": "string"
},
"date": {
"description": "Order date, YYYY-MM-DD.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"type": {
"description": "D = delivery, P = pickup, T = task.",
"type": "string",
"enum": [
"D",
"P",
"T"
]
},
"duration": {
"description": "Service time at the location, in minutes.",
"type": "number",
"minimum": 0
},
"priority": {
"description": "L low, M medium (default), H high, C critical.",
"type": "string",
"enum": [
"L",
"M",
"H",
"C"
]
},
"timeWindows": {
"description": "When the order can be serviced, e.g. [{\"twFrom\": \"10:00\", \"twTo\": \"14:00\"}].",
"type": "array",
"items": {
"type": "object",
"properties": {
"twFrom": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
},
"twTo": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
}
},
"required": [
"twFrom",
"twTo"
]
}
},
"allowedWeekdays": {
"description": "Weekdays the order may be scheduled on. Default: all.",
"type": "array",
"items": {
"type": "string",
"enum": [
"sun",
"mon",
"tue",
"wed",
"thu",
"fri",
"sat"
]
}
},
"allowedDates": {
"description": "Restrict the dates the order may be scheduled, e.g. {\"from\": \"2026-10-01\", \"to\": \"2026-10-07\"}.",
"type": "object",
"properties": {
"from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Date in YYYY-MM-DD format, e.g. 2026-09-30."
},
"to": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Date in YYYY-MM-DD format, e.g. 2026-09-30."
}
}
},
"allowedDateTimes": {
"description": "Datetime windows in which the service may begin.",
"type": "array",
"items": {
"type": "object",
"properties": {
"from": {
"description": "Earliest start, YYYY-MM-DDTHH:MM:SS.",
"type": [
"string",
"null"
]
},
"to": {
"description": "Latest start, YYYY-MM-DDTHH:MM:SS.",
"type": [
"string",
"null"
]
}
}
}
},
"assignedTo": {
"description": "Force the order onto one driver, e.g. {\"serial\": \"102\"} or {\"externalId\": \"444\"}. null clears it.",
"anyOf": [
{
"type": "object",
"properties": {
"serial": {
"type": "string"
},
"externalId": {
"type": "string"
}
}
},
{
"type": "null"
}
]
},
"load1": {
"description": "Load units #1 (boxes, kg, ...) per your capacity setup.",
"type": "number"
},
"load2": {
"description": "Load units #2.",
"type": "number"
},
"load3": {
"description": "Load units #3.",
"type": "number"
},
"load4": {
"description": "Load units #4.",
"type": "number"
},
"vehicleFeatures": {
"description": "Required vehicle feature codes.",
"type": "array",
"items": {
"type": "string"
}
},
"skills": {
"description": "Required driver skill codes.",
"type": "array",
"items": {
"type": "string"
}
},
"notes": {
"description": "Notes for the driver's instructions.",
"type": "string"
},
"email": {
"description": "Customer email for notifications.",
"type": "string"
},
"phone": {
"description": "Customer phone number.",
"type": "string"
},
"notificationPreference": {
"description": "How order-tracking notifications are delivered for this order.",
"type": "string",
"enum": [
"dont_notify",
"email",
"sms",
"both"
]
},
"relatedOrderNo": {
"description": "orderNo of a related pickup/delivery (set on the second order of the pair).",
"type": [
"string",
"null"
]
},
"relatedId": {
"description": "id of a related pickup/delivery.",
"type": [
"string",
"null"
]
},
"customField1": {
"description": "Legacy custom field #1.",
"type": "string"
},
"customField2": {
"description": "Legacy custom field #2.",
"type": "string"
},
"customField3": {
"description": "Legacy custom field #3.",
"type": "string"
},
"customField4": {
"description": "Legacy custom field #4.",
"type": "string"
},
"customField5": {
"description": "Legacy custom field #5.",
"type": "string"
},
"customFields": {
"description": "New-style custom fields keyed by the field key configured in OptimoRoute.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
}
},
"acceptDuplicateOrderNo": {
"description": "Allow CREATE of an order whose orderNo already exists.",
"type": "boolean"
},
"location": {
"description": "Where the order is serviced.",
"type": "object",
"properties": {
"locationNo": {
"description": "Number of an existing location. To reuse one, send ONLY locationNo (adding address or coordinates makes OptimoRoute geocode or create a new one).",
"type": "string"
},
"locationName": {
"description": "Location name.",
"type": "string"
},
"address": {
"description": "Full address including the country, e.g. 393 Hanover St, Boston, MA 02113, USA.",
"type": "string"
},
"latitude": {
"description": "Latitude.",
"type": "number",
"minimum": -90,
"maximum": 90
},
"longitude": {
"description": "Longitude.",
"type": "number",
"minimum": -180,
"maximum": 180
},
"checkInTime": {
"description": "Minimum waiting time at the location, in minutes.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"notes": {
"description": "Notes about the location, e.g. a gate code.",
"type": "string"
},
"acceptPartialMatch": {
"description": "Accept a lower-confidence geocoding match instead of erroring.",
"type": "boolean"
},
"acceptMultipleResults": {
"description": "Accept an address that geocodes to several results instead of erroring.",
"type": "boolean"
},
"storeInvalid": {
"description": "Store the order even if the address cannot be geocoded (it cannot be planned until fixed).",
"type": "boolean"
}
}
}
},
"required": [
"operation"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴optimoroute_create_or_update_orders(orders)
Create, update or replace up to 500 orders in one call. No geocoding here: each location must be an existing locationNo or carry latitude+longitude (+ locationNo, address or locationName). Per order, operation MERGE/SYNC/CREATE/UPDATE works as in optimoroute_create_order; by default an order matched by id or orderNo is updated with only the fields sent, otherwise created. Returns a per-order success list. OptimoRoute: POST /create_or_update_orders.
Eingabe-Schema
{
"type": "object",
"properties": {
"orders": {
"minItems": 1,
"maxItems": 500,
"type": "array",
"items": {
"type": "object",
"properties": {
"operation": {
"description": "Per-order operation; CREATE is not allowed together with id.",
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"MERGE",
"SYNC"
]
},
"orderNo": {
"description": "Your order number, shown in the web app. Used to match existing orders.",
"type": "string"
},
"id": {
"description": "OptimoRoute's order id. Takes priority over orderNo when matching.",
"type": "string"
},
"date": {
"description": "Order date, YYYY-MM-DD.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"type": {
"description": "D = delivery, P = pickup, T = task.",
"type": "string",
"enum": [
"D",
"P",
"T"
]
},
"duration": {
"description": "Service time at the location, in minutes.",
"type": "number",
"minimum": 0
},
"priority": {
"description": "L low, M medium (default), H high, C critical.",
"type": "string",
"enum": [
"L",
"M",
"H",
"C"
]
},
"timeWindows": {
"description": "When the order can be serviced, e.g. [{\"twFrom\": \"10:00\", \"twTo\": \"14:00\"}].",
"type": "array",
"items": {
"type": "object",
"properties": {
"twFrom": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
},
"twTo": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
}
},
"required": [
"twFrom",
"twTo"
]
}
},
"allowedWeekdays": {
"description": "Weekdays the order may be scheduled on. Default: all.",
"type": "array",
"items": {
"type": "string",
"enum": [
"sun",
"mon",
"tue",
"wed",
"thu",
"fri",
"sat"
]
}
},
"allowedDates": {
"description": "Restrict the dates the order may be scheduled, e.g. {\"from\": \"2026-10-01\", \"to\": \"2026-10-07\"}.",
"type": "object",
"properties": {
"from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Date in YYYY-MM-DD format, e.g. 2026-09-30."
},
"to": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Date in YYYY-MM-DD format, e.g. 2026-09-30."
}
}
},
"allowedDateTimes": {
"description": "Datetime windows in which the service may begin.",
"type": "array",
"items": {
"type": "object",
"properties": {
"from": {
"description": "Earliest start, YYYY-MM-DDTHH:MM:SS.",
"type": [
"string",
"null"
]
},
"to": {
"description": "Latest start, YYYY-MM-DDTHH:MM:SS.",
"type": [
"string",
"null"
]
}
}
}
},
"assignedTo": {
"description": "Force the order onto one driver, e.g. {\"serial\": \"102\"} or {\"externalId\": \"444\"}. null clears it.",
"anyOf": [
{
"type": "object",
"properties": {
"serial": {
"type": "string"
},
"externalId": {
"type": "string"
}
}
},
{
"type": "null"
}
]
},
"load1": {
"description": "Load units #1 (boxes, kg, ...) per your capacity setup.",
"type": "number"
},
"load2": {
"description": "Load units #2.",
"type": "number"
},
"load3": {
"description": "Load units #3.",
"type": "number"
},
"load4": {
"description": "Load units #4.",
"type": "number"
},
"vehicleFeatures": {
"description": "Required vehicle feature codes.",
"type": "array",
"items": {
"type": "string"
}
},
"skills": {
"description": "Required driver skill codes.",
"type": "array",
"items": {
"type": "string"
}
},
"notes": {
"description": "Notes for the driver's instructions.",
"type": "string"
},
"email": {
"description": "Customer email for notifications.",
"type": "string"
},
"phone": {
"description": "Customer phone number.",
"type": "string"
},
"notificationPreference": {
"description": "How order-tracking notifications are delivered for this order.",
"type": "string",
"enum": [
"dont_notify",
"email",
"sms",
"both"
]
},
"relatedOrderNo": {
"description": "orderNo of a related pickup/delivery (set on the second order of the pair).",
"type": [
"string",
"null"
]
},
"relatedId": {
"description": "id of a related pickup/delivery.",
"type": [
"string",
"null"
]
},
"customField1": {
"description": "Legacy custom field #1.",
"type": "string"
},
"customField2": {
"description": "Legacy custom field #2.",
"type": "string"
},
"customField3": {
"description": "Legacy custom field #3.",
"type": "string"
},
"customField4": {
"description": "Legacy custom field #4.",
"type": "string"
},
"customField5": {
"description": "Legacy custom field #5.",
"type": "string"
},
"customFields": {
"description": "New-style custom fields keyed by the field key configured in OptimoRoute.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
}
},
"acceptDuplicateOrderNo": {
"description": "Allow CREATE of an order whose orderNo already exists.",
"type": "boolean"
},
"location": {
"description": "Where the order is serviced.",
"type": "object",
"properties": {
"locationNo": {
"description": "Number of an existing location. To reuse one, send ONLY locationNo (adding address or coordinates makes OptimoRoute geocode or create a new one).",
"type": "string"
},
"locationName": {
"description": "Location name.",
"type": "string"
},
"address": {
"description": "Full address including the country, e.g. 393 Hanover St, Boston, MA 02113, USA.",
"type": "string"
},
"latitude": {
"description": "Latitude.",
"type": "number",
"minimum": -90,
"maximum": 90
},
"longitude": {
"description": "Longitude.",
"type": "number",
"minimum": -180,
"maximum": 180
},
"checkInTime": {
"description": "Minimum waiting time at the location, in minutes.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"notes": {
"description": "Notes about the location, e.g. a gate code.",
"type": "string"
}
}
}
}
},
"description": "The orders, at most 500."
}
},
"required": [
"orders"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴optimoroute_start_planning(date, dateRange, balancing, balanceBy, balancingFactor, ...)
Start OptimoRoute's route optimization for a date (or a dateRange for weekly planning, if the plan allows). With the default startWith EMPTY, existing routes for that date are REPLACED; use startWith CURRENT (+ lockType) to keep them. Returns a planningId — poll it with optimoroute_get_planning_status, then read the result with optimoroute_get_routes. Can be cancelled with optimoroute_stop_planning. OptimoRoute: POST /start_planning.
Eingabe-Schema
{
"type": "object",
"properties": {
"date": {
"description": "Date to plan, YYYY-MM-DD. Ignored if dateRange is set.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"dateRange": {
"description": "Plan several days at once (weekly planning).",
"type": "object",
"properties": {
"from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Date in YYYY-MM-DD format, e.g. 2026-09-30."
},
"to": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Date in YYYY-MM-DD format, e.g. 2026-09-30."
}
},
"required": [
"from",
"to"
]
},
"balancing": {
"description": "OFF best routes; ON balance workload; ON_FORCE balance and use every driver.",
"type": "string",
"enum": [
"OFF",
"ON",
"ON_FORCE"
]
},
"balanceBy": {
"description": "Balance by WT working time or NUM order count.",
"type": "string",
"enum": [
"WT",
"NUM"
]
},
"balancingFactor": {
"description": "0.0-1.0, how much balancing outweighs route cost (ON_FORCE only).",
"type": "number",
"minimum": 0,
"maximum": 1
},
"startWith": {
"description": "EMPTY (default) plans from scratch; CURRENT starts from existing routes.",
"type": "string",
"enum": [
"EMPTY",
"CURRENT"
]
},
"lockType": {
"description": "With CURRENT: NONE allow changes; ROUTES keep planned routes; RESOURCES keep driver per order.",
"type": "string",
"enum": [
"NONE",
"ROUTES",
"RESOURCES"
]
},
"midRouteDepotVisits": {
"description": "Allow mid-route depot visits (needs Dynamic Mid-Route Depots on the account).",
"type": "string",
"enum": [
"NONE",
"START",
"DYNAMIC"
]
},
"depotTrips": {
"description": "Let drivers return to the depot to reload.",
"type": "boolean"
},
"depotVisitDuration": {
"description": "Minutes spent at a depot visit.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"clustering": {
"description": "Minimize overlap between drivers' routes.",
"type": "boolean"
},
"useDrivers": {
"description": "Only plan with these drivers. Default: all available drivers.",
"type": "array",
"items": {
"type": "object",
"properties": {
"driverExternalId": {
"type": "string"
},
"driverSerial": {
"type": "string"
}
}
}
},
"useOrderObjects": {
"description": "Only plan these orders. Default: all valid orders on the date.",
"minItems": 1,
"maxItems": 500,
"type": "array",
"items": {
"type": "object",
"properties": {
"orderNo": {
"description": "The user-specified order number.",
"type": "string"
},
"id": {
"description": "OptimoRoute's unique order id.",
"type": "string"
}
}
}
},
"includeScheduledOrders": {
"description": "When planning a subset, keep other orders already scheduled on those drivers (default true).",
"type": "boolean"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴optimoroute_stop_planning(planningId)
Stop a running planning (optimization) process by its planningId. OptimoRoute: POST /stop_planning.
Eingabe-Schema
{
"type": "object",
"properties": {
"planningId": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The planningId returned by optimoroute_start_planning."
}
},
"required": [
"planningId"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴optimoroute_update_driver_parameters(externalId, date, enabled, workTimeFrom, workTimeTo, ...)
Change one driver's setup for one date: enable/disable, work hours, assigned vehicle, vehicle capacities, start/end location. WARNING: any existing route for that driver on that date is UNSCHEDULED; re-run planning afterwards. Start/end locations also apply to future optimizations. OptimoRoute: POST /update_driver_parameters.
Eingabe-Schema
{
"type": "object",
"properties": {
"externalId": {
"type": "string",
"description": "The driver's external id from driver administration."
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Date in YYYY-MM-DD format, e.g. 2026-09-30."
},
"enabled": {
"description": "Enable or disable the driver for this date.",
"type": "boolean"
},
"workTimeFrom": {
"description": "Work start, 24-hour HH:MM.",
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
},
"workTimeTo": {
"description": "Work end, 24-hour HH:MM.",
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
},
"assignedVehicle": {
"description": "External id of the vehicle to assign for this date.",
"type": "string"
},
"vehicleCapacity1": {
"description": "Vehicle load capacity #1 for this date.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"vehicleCapacity2": {
"description": "Vehicle load capacity #2.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"vehicleCapacity3": {
"description": "Vehicle load capacity #3.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"vehicleCapacity4": {
"description": "Vehicle load capacity #4.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"startLatitude": {
"description": "Start location latitude (needs startLongitude).",
"type": "number"
},
"startLongitude": {
"description": "Start location longitude (needs startLatitude).",
"type": "number"
},
"startAddress": {
"description": "Start address shown on reports (needs start coordinates).",
"type": "string"
},
"endLatitude": {
"description": "End location latitude (needs endLongitude).",
"type": "number"
},
"endLongitude": {
"description": "End location longitude (needs endLatitude).",
"type": "number"
},
"endAddress": {
"description": "End address shown on reports (needs end coordinates).",
"type": "string"
}
},
"required": [
"externalId",
"date"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴optimoroute_update_completion_details(updates)
Set the completion status of up to 500 orders (e.g. mark success, failed or cancelled from an external system), optionally with service start/end times. Each time takes unixTimestamp, utcTime or localTime. Reversible by setting the status again. Returns a per-order success list. OptimoRoute: POST /update_completion_details.
Eingabe-Schema
{
"type": "object",
"properties": {
"updates": {
"minItems": 1,
"maxItems": 500,
"type": "array",
"items": {
"type": "object",
"properties": {
"orderNo": {
"description": "The user-specified order number.",
"type": "string"
},
"id": {
"description": "OptimoRoute's unique order id.",
"type": "string"
},
"data": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"unscheduled",
"scheduled",
"on_route",
"servicing",
"success",
"failed",
"rejected",
"cancelled"
],
"description": "The new order status."
},
"startTime": {
"description": "When service started (servicing, success, failed).",
"type": "object",
"properties": {
"unixTimestamp": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"utcTime": {
"description": "ISO 8601, e.g. 2026-09-30T14:05:00.",
"type": "string"
},
"localTime": {
"description": "ISO 8601 local time at the order location.",
"type": "string"
}
}
},
"endTime": {
"description": "When service ended (success, failed).",
"type": "object",
"properties": {
"unixTimestamp": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"utcTime": {
"type": "string"
},
"localTime": {
"type": "string"
}
}
}
},
"required": [
"status"
]
}
},
"required": [
"data"
]
},
"description": "The status updates, at most 500."
}
},
"required": [
"updates"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴optimoroute_send_routes(date, sendNotifications)
Dispatch the routes for a date to the drivers' mobile app (the web app's Send Routes). This makes that date the live routes and CANNOT be unsent. sendNotifications defaults to FALSE here (OptimoRoute's own default is true); set it true only when you mean to email/SMS customers per the account's Order Tracking settings. Returns ERR_NOTHING_TO_SEND if nothing changed since the last send. Confirm with optimoroute_get_dispatch_status. OptimoRoute: POST /send_routes.
Eingabe-Schema
{
"type": "object",
"properties": {
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Date in YYYY-MM-DD format, e.g. 2026-09-30."
},
"sendNotifications": {
"description": "Also send customer notifications. Default false in this tool.",
"type": "boolean"
}
},
"required": [
"date"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Community
Nachweis