The Vehicle API provides endpoints for managing vehicles used in planning operations.
Conundra Vehicle API (0.0.3)
Download OpenAPI description
Overview
Servers
Mock server
https://developer.conundra.eu/_mock/apis/vehicles/vehicle-api/
Vehicle API Production
https://api.conundra.eu/vehicle/v1/
Request
Create or update a Vehicle. A unique ID (business_id) is required to identify the Vehicle. Calling this endpoint with an existing business_id will update the Vehicle.
Modifying (or retrieving) a Vehicle will provide the caller with a version number for this Vehicle. This version can be passed to the upsert endpoint as a weak ETag in the If-Match header. This allows the caller to ensure that the Vehicle has not been modified since the last time it was retrieved.
Security
clientCredentials
Headers Examples:
Bodyapplication/jsonThe RFC7240 Prefer header indicates that a particular server behavior is preferred by the client but is not required for successful completion of the request (see RFC 7240).
The following behavior (see Examples) is supported by this API:
- return=<minimal|representation> is used to suggest the server to return using 204 without resource (minimal) or using 200 or 201 with resource (representation) in the response body on success.
Indicate no response is needed, can be omitted
Request the result of the operation as response
Description of the vehicle.
Example: "Horn plays La Cucaracha - use sparingly in residential areas"
Whether OptiFlow must use this vehicle in a planning or not. If false, OptiFlow will only use this vehicle when it makes sense to do so.
Default false
Example: true
Unique identifier for this address.
Example: "50.9514048-3.8067878"
The part of the address that includes the street name, house number, bus number etc. Required when omitting geo_point.
Example: "Voordries 41"
A ISO3166-1 alpha-2 two letter country code. Required when omitting geo_point.
Service time at the start location, formatted as ISO-8601 duration.
Default "PT0S"
Example: "PT20M"
Indicates whether the orders to deliver are already available at the start location.
When true, the vehicle can begin deliveries immediately.
When false, the vehicle must first drive to a depot to pick up orders before it can start delivering.
Note: When the planning is a multi-tour VRP planning, only the orders to deliver on the first sub-tour are available at the start location.
Default false
Example: true
End location for the vehicle. Only one of the properties should be set.
Service time at the end location, formatted as ISO-8601 duration.
Default "PT0S"
Example: "PT15M"
Indicates whether the vehicle can end its route with picked-up orders still on board.
When true, the vehicle can drive directly to the end location with picked-up orders remaining on board.
When false, the vehicle must visit a depot to unload all picked-up orders before driving to the end location.
Default false
Example: true
Capabilities this vehicle provides. Used to make sure that orders requiring a specific capability, are only handled by vehicles with that capability.
Default []
Example: ["refrigerated","hazmat"]
Labels for categorizing vehicles. Can be used for facility filtering or defining constraints.
Default []
Example: ["priority","express"]
The color used to display this vehicle's route in the planning overview. Accepts CSS color names (e.g., "red", "blue") or hexadecimal color codes (e.g., "#FF5733", "#123DEF").
Example: "#FF5733"
- Mock serverhttps://developer.conundra.eu/_mock/apis/vehicles/vehicle-api/vehicles/{business_id}
- Vehicle API Productionhttps://api.conundra.eu/vehicle/v1/vehicles/{business_id}
Vehicle created or updated
A weak Etag (ex W/"<etag_value>") which contains the current version of the entity
Example: "W/\"25\""
Indicates whether a preference has been applied.
Example: "return=representation"
Unique identifier for this Vehicle.
Example: "truck-42"
Description of the vehicle.
Example: "Horn plays La Cucaracha - use sparingly in residential areas"
Whether OptiFlow must use this vehicle in a planning or not. If false, OptiFlow will only use this vehicle when it makes sense to do so.
Default false
Example: true
Unique identifier for this address.
Example: "50.9514048-3.8067878"
The part of the address that includes the street name, house number, bus number etc. Required when omitting geo_point.
Example: "Voordries 41"
A ISO3166-1 alpha-2 two letter country code. Required when omitting geo_point.
Service time at the start location, formatted as ISO-8601 duration.
Default "PT0S"
Example: "PT20M"
Indicates whether the orders to deliver are already available at the start location.
When true, the vehicle can begin deliveries immediately.
When false, the vehicle must first drive to a depot to pick up orders before it can start delivering.
Note: When the planning is a multi-tour VRP planning, only the orders to deliver on the first sub-tour are available at the start location.
Default false
Example: true
End location for the vehicle. Only one of the properties should be set.
Service time at the end location, formatted as ISO-8601 duration.
Default "PT0S"
Example: "PT15M"
Indicates whether the vehicle can end its route with picked-up orders still on board.
When true, the vehicle can drive directly to the end location with picked-up orders remaining on board.
When false, the vehicle must visit a depot to unload all picked-up orders before driving to the end location.
Default false
Example: true
Capabilities this vehicle provides. Used to make sure that orders requiring a specific capability, are only handled by vehicles with that capability.
Default []
Example: ["refrigerated","hazmat"]
Labels for categorizing vehicles. Can be used for facility filtering or defining constraints.
Default []
Example: ["priority","express"]
The color used to display this vehicle's route in the planning overview. Accepts CSS color names (e.g., "red", "blue") or hexadecimal color codes (e.g., "#FF5733", "#123DEF").
Example: "#FF5733"
Response
application/json
{ "business_id": "truck-42", "description": "Horn plays La Cucaracha - use sparingly in residential areas", "mandatory": true, "driver": { "name": "John Doe", "efficiency_factor": 1.2, "custom_data": { … } }, "start": { "location": { … }, "service_time": "PT20M", "orders_to_deliver_available": true }, "end": { "location": { … }, "service_time": "PT15M", "allow_picked_up_orders": true }, "deployability": { "window": { … }, "duration": { … } }, "capabilities": [ "refrigerated", "hazmat" ], "transport_resource": { "license_plate": "1-ABC-234", "capacities": [ … ], "custom_data": { … } }, "labels": [ "priority", "express" ], "cost": { "fixed": 50, "per_hour": 25, "per_kilometer": 0.5, "per_stop": 12, "overtime_per_hour": 30 }, "route_settings": { "routing_group": "medium-truck", "max_distance_in_kilometers": 450, "max_stops": 10, "driving_speed_factor": 1.5, "preferred_route_duration": { … } }, "color": "#FF5733", "break_rule_group": "BELGIUM-LEGAL" }
- Mock serverhttps://developer.conundra.eu/_mock/apis/vehicles/vehicle-api/vehicles/{business_id}
- Vehicle API Productionhttps://api.conundra.eu/vehicle/v1/vehicles/{business_id}
The Vehicle was successfully retrieved. Details are in the response body.
Bodyapplication/json
Unique identifier for this Vehicle.
Example: "truck-42"
Description of the vehicle.
Example: "Horn plays La Cucaracha - use sparingly in residential areas"
Whether OptiFlow must use this vehicle in a planning or not. If false, OptiFlow will only use this vehicle when it makes sense to do so.
Default false
Example: true
Unique identifier for this address.
Example: "50.9514048-3.8067878"
The part of the address that includes the street name, house number, bus number etc. Required when omitting geo_point.
Example: "Voordries 41"
A ISO3166-1 alpha-2 two letter country code. Required when omitting geo_point.
Service time at the start location, formatted as ISO-8601 duration.
Default "PT0S"
Example: "PT20M"
Indicates whether the orders to deliver are already available at the start location.
When true, the vehicle can begin deliveries immediately.
When false, the vehicle must first drive to a depot to pick up orders before it can start delivering.
Note: When the planning is a multi-tour VRP planning, only the orders to deliver on the first sub-tour are available at the start location.
Default false
Example: true
End location for the vehicle. Only one of the properties should be set.
Service time at the end location, formatted as ISO-8601 duration.
Default "PT0S"
Example: "PT15M"
Indicates whether the vehicle can end its route with picked-up orders still on board.
When true, the vehicle can drive directly to the end location with picked-up orders remaining on board.
When false, the vehicle must visit a depot to unload all picked-up orders before driving to the end location.
Default false
Example: true
Capabilities this vehicle provides. Used to make sure that orders requiring a specific capability, are only handled by vehicles with that capability.
Default []
Example: ["refrigerated","hazmat"]
Labels for categorizing vehicles. Can be used for facility filtering or defining constraints.
Default []
Example: ["priority","express"]
The color used to display this vehicle's route in the planning overview. Accepts CSS color names (e.g., "red", "blue") or hexadecimal color codes (e.g., "#FF5733", "#123DEF").
Example: "#FF5733"
Response
application/json
{ "business_id": "truck-42", "description": "Horn plays La Cucaracha - use sparingly in residential areas", "mandatory": true, "driver": { "name": "John Doe", "efficiency_factor": 1.2, "custom_data": { … } }, "start": { "location": { … }, "service_time": "PT20M", "orders_to_deliver_available": true }, "end": { "location": { … }, "service_time": "PT15M", "allow_picked_up_orders": true }, "deployability": { "window": { … }, "duration": { … } }, "capabilities": [ "refrigerated", "hazmat" ], "transport_resource": { "license_plate": "1-ABC-234", "capacities": [ … ], "custom_data": { … } }, "labels": [ "priority", "express" ], "cost": { "fixed": 50, "per_hour": 25, "per_kilometer": 0.5, "per_stop": 12, "overtime_per_hour": 30 }, "route_settings": { "routing_group": "medium-truck", "max_distance_in_kilometers": 450, "max_stops": 10, "driving_speed_factor": 1.5, "preferred_route_duration": { … } }, "color": "#FF5733", "break_rule_group": "BELGIUM-LEGAL" }