OptimizationRequest

@Serializable
data class OptimizationRequest(val jobs: List<Job>? = null, val shipments: List<Shipment>? = null, val vehicles: List<Vehicle>, val matrices: Map<String, CustomMatrix>? = null, val options: Map<String, JsonElement>? = null)

Root payload sent to /optimization See: https://github.com/VROOM-Project/vroom/blob/master/docs/API.md

Constructors

Link copied to clipboard
constructor(jobs: List<Job>? = null, shipments: List<Shipment>? = null, vehicles: List<Vehicle>, matrices: Map<String, CustomMatrix>? = null, options: Map<String, JsonElement>? = null)

Properties

Link copied to clipboard
val jobs: List<Job>? = null

Required: either jobs and/or shipments, and vehicles

Link copied to clipboard

Optional custom matrices keyed by routing profile (e.g. "driving-car")

Link copied to clipboard
val options: Map<String, JsonElement>? = null

Optional free-form options bag passed to the optimization engine

Link copied to clipboard
val shipments: List<Shipment>? = null
Link copied to clipboard