Fleet Route Optimizer

{'type': 'object', 'required': ['name'], 'properties': {'lang': {'enum': ['en', 'es'], 'type': 'string', 'description': 'es = Spanish labels.'}, 'name': {'type': 'string'}}, 'additionalProperties': False}

{'type': 'object', 'required': ['job_id'], 'properties': {'job_id': {'type': 'string'}, 'wait_seconds': {'type': 'integer', 'maximum': 45, 'minimum': 0}}, 'additionalProperties': False}

{'type': 'object', 'properties': {}, 'additionalProperties': False}

{'type': 'object', 'properties': {'depot': {'type': 'object', 'properties': {'id': {'type': 'string'}, 'lat': {'type': 'number', 'description': 'Latitude, decimal degrees.'}, 'lon': {'type': 'number', 'description': 'Longitude, decimal degrees.'}, 'open': {'type': ['string', 'number'], 'description': "Earliest departure. Clock time 'HH:MM' (24 h), '8:30 AM', or minutes after midnight (480 = 08:00). Default 00:00."}, 'close': {'type': ['string', 'number'], 'description': "Latest return. Clock time 'HH:MM' (24 h), '8:30 AM', or minutes after midnight (480 = 08:00). Default 24:00."}, 'address': {'type': 'string', 'description': 'Street address to geocode. Include city and ZIP/postcode. Not needed when lat and lon are given (lat/lon is faster and never fails).'}}, 'description': 'Where every vehicle starts and ends. Needs an address or lat+lon.'}, 'stops': {'type': 'array', 'items': {'type': 'object', 'properties': {'id': {'type': 'string', 'description': "Your label for the stop (customer name, order no.). Used in results and in previous_routes. Default 'stop N' (1-based)."}, 'lat': {'type': 'number', 'description': 'Latitude, decimal degrees.'}, 'lon': {'type': 'number', 'description': 'Longitude, decimal degrees.'}, 'demand': {'type': 'number', 'description': 'Quantity delivered here (boxes, kg...). Counts against vehicle capacity. Default 0.'}, 'address': {'type': 'string', 'description': 'Street address to geocode. Include city and ZIP/postcode. Not needed when lat and lon are given (lat/lon is faster and never fails).'}, 'demand2': {'type': 'number', 'description': 'Second quantity (e.g. weight), against capacity2.'}, 'demand3': {'type': 'number', 'description': 'Third quantity (e.g. pallets), against capacity3.'}, 'closed_to': {'type': ['string', 'number'], 'description': 'End of that period.'}, 'closed_from': {'type': ['string', 'number'], 'description': "Start of a period inside the window when the stop cannot be visited (e.g. lunch). Clock time 'HH:MM' (24 h), '8:30 AM', or minutes after midnight (480 = 08:00)."}, 'window_open': {'type': ['string', 'number'], 'description': "Earliest arrival. Clock time 'HH:MM' (24 h), '8:30 AM', or minutes after midnight (480 = 08:00). Default 00:00."}, 'window_close': {'type': ['string', 'number'], 'description': "Latest arrival. Clock time 'HH:MM' (24 h), '8:30 AM', or minutes after midnight (480 = 08:00). Default 24:00. Hard unless parameters.LatePenaltyPerMinute > 0."}, 'service_minutes': {'type': 'number', 'description': 'Minutes spent at the stop. Default 0.'}}}, 'maxItems': 100, 'minItems': 1, 'description': 'The places to visit (not the depot). Each needs an address or lat+lon.'}, 'country': {'enum': ['US', 'OTHER'], 'type': 'string', 'description': 'Which geocoder reads the addresses: US (US Census, then OpenStreetMap) or OTHER (OpenStreetMap). Default US.'}, 'example': {'type': 'string', 'description': 'Solve this built-in example instead of passing the fields below.'}, 'vehicles': {'oneOf': [{'type': 'integer', 'maximum': 25, 'minimum': 1}, {'type': 'array', 'items': {'type': 'object', 'properties': {'id': {'type': 'string', 'description': "Name, e.g. 'Van 1'."}, 'capacity': {'type': 'number', 'description': 'Max total demand. Omitted = unlimited.'}, 'capacity2': {'type': 'number'}, 'capacity3': {'type': 'number'}, 'fixed_cost': {'type': 'number', 'description': 'Cost of using this vehicle at all, in driving minutes. Raise it to use fewer vehicles. Default 0.'}, 'speed_factor': {'type': 'number', 'description': 'Driving time multiplier: 1.2 = 20% slower. Default 1.'}, 'service_factor': {'type': 'number', 'description': 'Service time multiplier. Default 1.'}, 'max_route_minutes': {'type': 'number', 'description': 'Longest route, depot to depot, waiting included.'}}}, 'maxItems': 25, 'minItems': 1}], 'description': 'Either a number of identical vehicles (unlimited capacity), or one object per vehicle.'}, 'parameters': {'type': 'object', 'description': 'Optional engine settings: SearchParametersTimeLimit (seconds, default 30, max 60), NoImprovementSeconds (20), RouteTimeLimit (minutes, default 1440), DroppedOrderCost (100000 = serve every stop that can be served), MinuteCost (1), LatePenaltyPerMinute (0 = windows are hard), MaxWaitMinutes (1440), MinimumDriveTime (5).'}, 'wait_seconds': {'type': 'integer', 'maximum': 45, 'minimum': 0, 'description': 'How long to wait for the solve inside this call (default 25).'}, 'previous_routes': {'type': 'array', 'items': {'type': 'array', 'items': {'type': ['string', 'integer']}}, 'description': 'Re-optimize from existing routes: one list of stop ids (or 1-based stop numbers) per vehicle, in visiting order. The solver starts from these and improves them; new stops are fitted in.'}}}