Raw schema
{
"type": "object",
"properties": {
"vehicles": {
"items": {
"$ref": "#/$defs/VehicleSpec"
},
"minItems": 1,
"title": "Vehicles",
"type": "array"
},
"orders": {
"items": {
"$ref": "#/$defs/OrderSpec"
},
"minItems": 1,
"title": "Orders",
"type": "array"
},
"depot": {
"anyOf": [
{
"$ref": "#/$defs/Place"
},
{
"type": "null"
}
],
"default": null,
"description": "Where the vehicles start from. Omit only if your API key is bound to a depot, in which case the server supplies it."
},
"max_deliveries_per_vehicle": {
"default": 2,
"description": "How many consecutive delivery runs to plan per vehicle. Only the first run of each vehicle needs dispatching now: plan again when a vehicle returns.",
"maximum": 2,
"minimum": 1,
"title": "Max Deliveries Per Vehicle",
"type": "integer"
},
"optimization_seconds": {
"default": 5,
"description": "Solver time budget in seconds; more can give slightly better plans. Below 5 the plan is returned with a warning, as priority orders may not be sent out first.",
"maximum": 15,
"minimum": 1,
"title": "Optimization Seconds",
"type": "integer"
},
"factor_wait": {
"default": 1,
"description": "Cost per minute of every order's wait, from received_at to arrival (default 1). Only its ratio to factor_wait_excess matters; leave the default unless the user asks for something specific.",
"maximum": 100,
"minimum": 0,
"title": "Factor Wait",
"type": "number"
},
"factor_wait_excess": {
"default": 10,
"description": "Lateness weight: extra cost per minute an order is late, beyond its wait_target_minutes plus distance grace (default 10), so 40 minutes late costs far more than 5. Values from 1 to 100 give similar plans: the default keeps the late tail down without raising the average wait. Change it only if the user asks to trade one for the other.",
"maximum": 10000,
"minimum": 0,
"title": "Factor Wait Excess",
"type": "number"
},
"freshness": {
"anyOf": [
{
"$ref": "#/$defs/Freshness"
},
{
"type": "null"
}
],
"default": null,
"description": "Freshness class for orders that don't give their own, usually the shop's kind of goods: hot (hot meals), cold (iced coffee, cold drinks), crispy (fries, delicate food), frozen, or robust (not modelled, the default). Sensitive orders get shorter rides at a cost of about 0.5-1 minute average wait per protected class."
}
},
"required": [
"vehicles",
"orders"
],
"$defs": {
"Freshness": {
"description": "Goods class for how fast an order loses quality on the road. Resolved\nby optimise() into a degrade start and weight relative to\nfactor_wait_excess - see FRESHNESS_TERMS and LESSONS_LEARNED.md\n(\"Freshness classes\").",
"enum": [
"robust",
"hot",
"cold",
"crispy",
"frozen"
],
"title": "Freshness",
"type": "string"
},
"OrderSpec": {
"properties": {
"address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Street address, geocoded server-side when lat/lon are omitted",
"title": "Address"
},
"lat": {
"anyOf": [
{
"description": "Latitude in decimal degrees",
"maximum": 90,
"minimum": -90,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Lat"
},
"lon": {
"anyOf": [
{
"description": "Longitude in decimal degrees",
"maximum": 180,
"minimum": -180,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Lon"
},
"id": {
"description": "Your reference for the order",
"title": "Id",
"type": "string"
},
"received_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "When the customer placed the order. Omit to mean now.",
"title": "Received At"
},
"ready_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "When the order is ready to leave the depot. Omit to mean now.",
"title": "Ready At"
},
"wait_target_minutes": {
"default": 15,
"description": "Promised wait, from received_at to arrival at the customer",
"minimum": 0,
"title": "Wait Target Minutes",
"type": "number"
},
"priority": {
"default": false,
"description": "Send this order out as soon as possible",
"title": "Priority",
"type": "boolean"
},
"freshness": {
"anyOf": [
{
"$ref": "#/$defs/Freshness"
},
{
"type": "null"
}
],
"default": null,
"description": "How fast the order loses quality on the road: robust (not modelled), hot (hot meals), cold (iced coffee, cold drinks), crispy (fries, delicate food) or frozen. Omit to use plan_deliveries' freshness."
}
},
"required": [
"id"
],
"title": "OrderSpec",
"type": "object"
},
"Place": {
"description": "A location given either as a street address or as coordinates.",
"properties": {
"address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Street address, geocoded server-side when lat/lon are omitted",
"title": "Address"
},
"lat": {
"anyOf": [
{
"description": "Latitude in decimal degrees",
"maximum": 90,
"minimum": -90,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Lat"
},
"lon": {
"anyOf": [
{
"description": "Longitude in decimal degrees",
"maximum": 180,
"minimum": -180,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Lon"
}
},
"title": "Place",
"type": "object"
},
"VehicleSpec": {
"properties": {
"id": {
"description": "Your reference for the vehicle or driver",
"title": "Id",
"type": "string"
},
"capacity": {
"default": 5,
"description": "How many orders the vehicle can carry at once",
"exclusiveMinimum": 0,
"title": "Capacity",
"type": "integer"
},
"available_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "When the vehicle is back at the depot and free for a new route. Omit if it is available now.",
"title": "Available At"
}
},
"required": [
"id"
],
"title": "VehicleSpec",
"type": "object"
}
},
"title": "plan_deliveriesArguments"
}