Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Check the Migration Guide for complete steps required for upgrading to a new version.

[1.1.3] - 2025-10-31

Added

• /optimize endpoint:
  • user-defined matrices support for optimization requests
  • orders sequences specifies the association between different orders that should be visited in a certain order
• /optimize/solution endpoint:
  • new endpoint for returning solution of an optimize request

Changed

• Implemented asynchronous background execution for the solver using a request-based mechanism
• Added wrapper over VROOM in Solver project for improved functionality

Fixed

• eBike load-dependent matrix calculations in /optimize requests
• Issue with deleting orders that were already used in a route
• Issue with invalid coordinates scenarios in /optimize requests

[1.1.2] - 2025-09-30

Added

• /optimize endpoint:
  • customData field to orders schema (input and output)
  • droppedOrders field to output schema
  • arrivalTime field for destination in output schema
  • more detailed response error messages.
• /optimize/landmarks endpoint:
  • droppedIndexes field to output schema
• droppedOrders field to multiple endpoints output:
  • /optimizations/{id}/solution
  • /optimizations/solution

Fixed

• Arrival and wait time calculations for route orders for /optimize output.
• Fuel consumption calculations for /optimize output.
• Route's total time computation for/optimize output.
• Wait time calculation for RouteOrder.
• Route's arrival time calculation.

Removed

• Removed configurationParameters from the /optimize output schema

[1.1.1] - 2025-08-29

Changed

• Extended /optimize input and output schemas:

  • Input now supports named identifiers alias for orders, departures, destinations, vehicle names and license plates, multiple depots, and richer configuration parameters.
  • Output expanded from a simple order index list to full route details, including orders with matched locations, timing, vehicle state, and aggregated route metrics.

• Changed optimizationsAndRoutes response schema in customers/{id}/history endpoint:

  • optimizationsAndRoutes (array) replaced with optimizationAndRoute (object).
  • routes (array) replaced with route (object property with items).

[1.1.0] - 2025-07-31

Added

• Added /optimize endpoint for comprehensive route optimization with support for multiple vehicles, constraints, and configuration parameters, returning complete routing solutions in a stateless manner.
• Added /optimize/landmarks endpoint that provides stateless, lightweight route optimization by accepting coordinates and vehicle type to return optimized sequence indexes for real-time planning.

Fixed

• Fixed and optimized handling of orders with 24+ hour time windows:
  • Resolved solution correctness issues
  • Improved solver performance

[1.0.0] - 2025-06-30

Initial release