HERE Tour Planning API Changelog
Loading changelog...
| Version | Type | Description |
|---|---|---|
| 3.59.0 | ADDED | [ALPHA] Per-job cost function: configure cost per job on vehicle with perJob in VehicleCosts, job-level costFactor, and optional per-job overrides. |
| 3.59.0 | ADDED | [ALPHA] Cost statistics: breakdown of total cost into individual components (distance, time, fixed, perJob, perWaitingTime, excess) in the solution Statistic. |
| 3.59.0 | ADDED | [ALPHA] Vehicle compartments: define multiple compartments per vehicle with separate capacities and per-compartment mixing restrictions. |
| 3.59.0 | ADDED | [ALPHA] Added the following properties: - CostStatistics with breakdown of cost into individual components (distance, time, fixed, perJob, perWaitingTime, excess)- ExcessCostStatistics with excess costs broken down by metric (distance, duration, stops, waitingTime)- costs to Statistic with cost breakdown- costFactor to Job for per-job cost calculation- perJob to VehicleCosts with VehicleJobCost schema- JobCostOverride for per-job cost override for specific job IDs- Compartment schema for vehicle compartment definitions- compartments to VehicleType as alternative to capacity- compartments to MixingRestrictionSet for per-compartment mixing restrictions- loadPerCompartment to Stop in solution- compartment to Activity in solution |
| 3.59.0 | CHANGED | capacity is no longer required on VehicleType (either capacity or compartments must be set). |
| 3.58.6 | ADDED | [ALPHA] Added backToVehicle to ActivityType. |
| 3.58.5 | ADDED | [ALPHA] Added usePublicStations to VehicleCharging. |
| 3.58.4 | CHANGED | Promoted route violations and violationMapping from alpha to stable. |
| 3.58.3 | ADDED | [ALPHA] Added searchEffort field to Termination to control solver termination sensitivity. |
| 3.58.3 | ADDED | [ALPHA] Added searchEffort field to Termination to control how aggressively the solver terminates when progress slows down (quick, balanced, thorough). |
| 3.58.2 | CHANGED | Change PudoPlace.location and ParkingPlace.location type to RoutingLocation (to support sideOfTheStreetHint and nameHint). |
| 3.58.1 | CHANGED | Promoted placement property on Group from alpha to stable. |
| 3.58.1 | CHANGED | Promoted flexible job grouping from alpha to stable. |
| 3.58.0 | ADDED | [ALPHA] Added chargingStations to Shared with vehicleTypeToDuration mapping. |
| 3.58.0 | ADDED | [ALPHA] Added maxDistance to VehicleCharging. |
| 3.58.0 | ADDED | [ALPHA] Support for EV consumption-based recharges with shared charging stations. |
| 3.58.0 | REMOVED | [ALPHA] Removed recharges from VehicleShift. |
| 3.58.0 | REMOVED | [ALPHA] Removed VehicleRecharges and VehicleRechargeStation schemas. |
| 3.58.0 | CHANGED | [ALPHA] VehicleCharging no longer requires evProfileId (allows distance-based charging without EV profile). |
| 3.58.0 | DEPRECATED | amount in VehicleType - use vehicleIds instead. |
| 3.57.1 | CHANGED | Promoted VehicleFuel, consumption and co2Emission in Statistic from alpha to stable. |
| 3.57.1 | CHANGED | Promoted fuel consumption and CO2 emission from alpha to stable. |
| 3.57.0 | REMOVED | [ALPHA] stopProfile removed from VehicleShift. |
| 3.57.0 | CHANGED | [ALPHA] Mark StopConfig as deprecated. |
| 3.57.0 | DEPRECATED | [ALPHA] Deprecate stopConfiguration. |
| 3.56.2 | ADDED | [ALPHA] Allow jobs with linked parking ids in relations. |
| 3.56.0 | ADDED | [ALPHA] Added canStartEarly in VehicleFixedDutyRestTime. |
| 3.56.0 | ADDED | [ALPHA] Introduce canStartEarly in VehicleFixedDutyRestTime to enable flexible duty breaks start. |
| 3.55.0 | ADDED | [ALPHA] Added location to ParkingPlace. |
| 3.54.0 | ADDED | [ALPHA] Added stopConfiguration. |
| 3.54.0 | ADDED | [ALPHA] Introduce stopConfiguration to replace stopConfig. |
| 3.54.0 | DEPRECATED | [ALPHA] Mark stopProfile as deprecated. |
| 3.53.0 | CHANGED | [BETA] Promoted excessCosts to beta. |
| 3.52.0 | ADDED | [ALPHA] Added stopProfile to VehicleShift to deprecate stopConfig.profile. |
| 3.52.0 | ADDED | [ALPHA] Introduce stopProfile to deprecate stopConfig.profile. |
| 3.51.0 | ADDED | [ALPHA] Added maxIntraStopDistance. |
| 3.51.0 | ADDED | [ALPHA] Introduce maxIntraStopDistance. |
| 3.50.0 | ADDED | Added intraStopDistance to Stop. |
| 3.50.0 | ADDED | Added intraStopDistance to Statistic. |
| 3.50.0 | ADDED | Added arrival to Interval. |
| 3.50.0 | ADDED | Added intraStop to Timing. |
| 3.50.0 | ADDED | Start reporting intraStopDistance. |
| 3.50.0 | ADDED | Start reporting arrival for the Activity. |
| 3.50.0 | CHANGED | Optimize the order of Activities inside Stops by minimizing the intraStopDistance. |
| 3.49.0 | REMOVED | [ALPHA] Removed traffic from ignoreRouteViolations. |
| 3.49.0 | ADDED | [ALPHA] Added support for violation mapping. |
| 3.48.2 | ADDED | [ALPHA] Added vehicleTypeIds to ParkingPlace. |
| 3.48.2 | CHANGED | [ALPHA] Increased max limit of parking places from 1 to 10. |
| 3.48.0 | CHANGED | [BETA] Promote 1-5 priorities to beta. |
| 3.48.0 | CHANGED | [BETA] Promote PUDO to beta. |
| 3.47.0 | ADDED | Added details to UnassignedJobReason in the Solution. |
| 3.47.0 | ADDED | [ALPHA] Multiple reason codes for unassigned jobs. |
| 3.46.0 | ADDED | [ALPHA] Add support for location specific duration via shared parking places. |
| 3.45.6 | CHANGED | Changed maximum limit for shiftTime and maxDrivingTime from 86400 to 604800 seconds (7 days). |
| 3.45.5 | CHANGED | Changed maximum limit for maxDistanceToNeighbor in dbscan stop configuration from 75 to 500 meters. |
| 3.45.2 | CHANGED | Promoted polylines from alpha to stable. |
| 3.45.1 | CHANGED | [BETA] Promote rest time's driving and working break from alpha to beta. |
| 3.45.0 | ADDED | [ALPHA] Added profile to stopConfig for walk optimized clustering. |
| 3.45.0 | ADDED | [ALPHA] Walk optimized clustering. |
| 3.44.5 | ADDED | [ALPHA] Added excess costs for duration. |
| 3.44.5 | ADDED | [ALPHA] Add excess costs for duration. |
| 3.44.2 | ADDED | [ALPHA] Add excess costs for waiting time. |
| 3.44.1 | ADDED | [ALPHA] Cost per waiting time. |
| 3.44.0 | ADDED | [ALPHA] Ignore traffic route violations. |
| 3.43.1 | ADDED | [ALPHA] Added minimizeSoftTimeWindowViolations advanced objective. |
| 3.43.0 | ADDED | [ALPHA] Added support for flexible groups. |
| 3.42.0 | CHANGED | Only allow certain objectives in tie break objective. |
| 3.41.0 | ADDED | [ALPHA] Added excess costs feature. |
| 3.40.0 | ADDED | [ALPHA] Added recharges to VehicleShift. |
| 3.40.0 | ADDED | [ALPHA] Added support for EV. |
| 3.39.0 | ADDED | [ALPHA] Added tieBreak advanced objective. |
| 3.39.0 | ADDED | [ALPHA] Support for new tieBreak advanced objective. |
| 3.38.1 | CHANGED | [ALPHA] Changed min limit for max driving/working duty rule. |
| 3.38.0 | CHANGED | Promoted max driving time per shift from alpha to stable. |
| 3.37.0 | ADDED | [ALPHA] Added dutyRule to VehicleRestTime. |
| 3.37.0 | ADDED | [ALPHA] Added support for duty rest time breaks. |
| 3.36.1 | REMOVED | Removed category from BusOptions. |
| 3.36.0 | ADDED | [ALPHA] Added maxDrivingTime to VehicleLimits. |
| 3.36.0 | ADDED | [ALPHA] Added support for max driving time. |
| 3.35.2 | ADDED | Added axleCount to VehicleOptions, CarOptions and TaxiOptions. |
| 3.35.0 | ADDED | [ALPHA] Added routeDetails with polyline to Configuration. |
| 3.35.0 | ADDED | [ALPHA] Added fuel to VehicleType. |
| 3.35.0 | ADDED | [ALPHA] Added support for route polylines. |
| 3.35.0 | ADDED | [ALPHA] Added support for fuel consumption and CO2 emissions. |
| 3.34.0 | ADDED | Added weightPerAxleGroup to VehicleOptions. |
| 3.34.0 | ADDED | Added trailerCount to VehicleOptions and CarOptions. |
| 3.34.0 | ADDED | Added seasonalClosure to AvoidFeatures. |
| 3.34.0 | ADDED | Added speed to pedestrian profile options. |
| 3.34.0 | ADDED | Added areas to Exclude. |
| 3.34.0 | ADDED | Added taxi profile. |
| 3.33.0 | ADDED | Support for shift location tag. |
| 3.32.0 | ADDED | [ALPHA] Support for eager delivery. |
| 3.31.2 | UPDATED | Updated documentation for the upload matrix endpoint. |
| 3.31.1 | UPDATED | Updated documentation for the upload matrix endpoint. |
| 3.31.0 | ADDED | Added policy to vehicle break. |
| 3.31.0 | ADDED | [ALPHA] Added TimeWindows property to JobPlace. |
| 3.31.0 | ADDED | [ALPHA] Allow pudos in relations. |
| 3.31.0 | ADDED | [ALPHA] Added houseKeyId property to JobPlace. |
| 3.31.0 | ADDED | Added id to the Location. |
| 3.31.0 | ADDED | [ALPHA] Increased maximum job priority levels to five. |
| 3.31.0 | ADDED | [ALPHA] Added endpoint for uploading custom matrices (Please contact your regional HERE representative to get access to this endpoint). |
| 3.31.0 | ADDED | [ALPHA] Added serveInClusters advanced objective. |
| 3.31.0 | ADDED | Support for break at the end of the tour. |
| 3.31.0 | ADDED | [ALPHA] Support for soft time windows. |
| 3.31.0 | ADDED | [ALPHA] Support for house key id. |
| 3.31.0 | ADDED | Support for location IDs in jobs. |
| 3.31.0 | ADDED | [ALPHA] Support for custom matrix in async request flow (Please contact your regional HERE representative to get access to this feature). |
| 3.31.0 | CHANGED | [ALPHA] Used MatrixOrigin model instead of Location in custom matrix origins array. |
| 3.30.1 | ADDED | Added validation in case relation has mixing of groups inside. |
| 3.30.0 | ADDED | [ALPHA] Added matrix to vehicle profile. |
| 3.30.0 | ADDED | [ALPHA] Support for custom matrix. |
| 3.29.0 | ADDED | [ALPHA] Added minimizeTourOverlap advanced objective. |
| 3.29.0 | ADDED | Added position to the JobTask. |
| 3.29.0 | ADDED | Support for wildcard (any) task position. |
| 3.29.0 | CHANGED | Increased maximum number of breaks in a shift to 5. |
| 3.29.0 | DEPRECATED | Marked order in JobTask as deprecated. |
| 3.28.1 | CHANGED | Changed tolerance range for VisuallyAppealingTours objective. |
| 3.28.0 | CHANGED | Changed notice's code type from enum to string. |
| 3.27.0 | ADDED | [ALPHA] Added advancedObjectives. |
| 3.26.0 | ADDED | Added groups to the Plan. |
| 3.26.0 | ADDED | Added stopConfig to the VehicleShift. |
| 3.26.0 | ADDED | [ALPHA] Pudo support for job groups. |
| 3.26.0 | ADDED | [ALPHA] Support for cluster nearby. |
| 3.25.2 | CHANGED | Changed description of UNREACHABLE_IN_RELATION_CONSTRAINT. |
| 3.25.1 | CHANGED | conflictingCategories maximum allowed size has been reduced from 1000 to 100. |
| 3.25.0 | ADDED | Added groupId in the JobPlace. |
| 3.25.0 | ADDED | Added maxTimeOnVehicle to the Job. |
| 3.25.0 | ADDED | Added experimentalFeatures array to problem configuration. |
| 3.25.0 | ADDED | Added minCount in the VehicleStopsLimit. |
| 3.25.0 | ADDED | Added category to the Job. |
| 3.25.0 | ADDED | Added mixingRestrictions to the VehicleShift. |
| 3.25.0 | ADDED | Added restTimes in the VehicleShift. |
| 3.25.0 | ADDED | Support for optional start/end location in vehicle shift. |
| 3.25.0 | ADDED | Support for job groups. |
| 3.25.0 | ADDED | Support for limiting the time spent in the vehicle. |
| 3.25.0 | ADDED | Support for mixed loading restrictions. |
| 3.25.0 | ADDED | [ALPHA] Support for minimum stops per shift. |
| 3.25.0 | ADDED | [ALPHA] Support for rest times. |
| 3.25.0 | CHANGED | location is not required anymore on the VehiclePlace. |
| 3.24.4 | ADDED | Added notices for unreachable locations. |
| 3.24.3 | CHANGED | Improved the descriptions for the JobId and PlaceTag parameters. |
| 3.24.2 | CHANGED | Created RoutingLocation for each location object used in the problem. |
| 3.24.1 | CHANGED | Added separate error code for too many jobs, too many vehicle types and for general api validation. |
| 3.24.0 | ADDED | Added ignoreRouteViolations to vehicle profile. |
| 3.24.0 | ADDED | Allow user to ignore route violations on vehicle profile basis. |
| 3.23.1 | CHANGED | Improved cost calculations when minimizeDistance and minimizeDuration objectives are being used. |
| 3.23.0 | ADDED | Added notices to the solution. |
| 3.22.0 | CHANGED | The limit async job tasks is increased from 3000 to 6000. |
| 3.22.0 | CHANGED | Increased async job tasks limit to 6000. |
| 3.21.0 | ADDED | Added traffic mode to vehicle profile. |
| 3.21.0 | ADDED | Added speed cap to vehicle profile. |
| 3.21.0 | ADDED | Support for disabled traffic mode on vehicle profile level. |
| 3.21.0 | ADDED | Support for speedCap parameter in vehicle profile options for car, truck and scooter. |
| 3.20.0 | ADDED | Vehicle-dependent stop base duration feature. |
| 3.20.0 | ADDED | Added speedFactor to vehicle type. |
| 3.20.0 | ADDED | Support for speedFactor in vehicle type. |
| 3.19.0 | ADDED | Added timeOffset property to vehicle shift start. |
| 3.19.0 | ADDED | Allow controlling departure time optimization offset with timeOffset property on vehicle shift start. |
| 3.18.0 | ADDED | Added vehicleIds array to vehicle type. |
| 3.18.0 | ADDED | Support for vehicleIds array in vehicle type. |
| 3.17.0 | ADDED | Added optimizeTaskOrder objective. |
| 3.17.0 | ADDED | Added two fleet profiles: bus and privateBus. |
| 3.17.0 | ADDED | Support for new optimizeTaskOrder objective. |
| 3.17.0 | ADDED | Support for bus and private bus profiles. |
| 3.17.0 | CHANGED | Waiting time now impacts start time of activities. An activity start time will start after waiting time. |
| 3.16.0 | ADDED | Added two objectives: minimizeDistance, minimizeDuration. |
| 3.16.0 | ADDED | Support for new objectives: minimizeDistance, minimizeDuration. |
| 3.15.0 | ADDED | Added category to truck options. |
| 3.15.0 | ADDED | Added distance in solution. |
| 3.15.0 | ADDED | Support for light truck option. |
| 3.15.0 | ADDED | Distance from start of tour to each stop. |
| 3.14.0 | ADDED | Maximum number of stops attribute. |
| 3.14.0 | ADDED | objectives attribute. |
| 3.14.0 | ADDED | Added name hint attribute to location. |
| 3.14.0 | ADDED | Support maximum number of stops. |
| 3.14.0 | ADDED | Support objectives. |
| 3.14.0 | ADDED | Support name hint attribute in location. |
| 3.13.0 | ADDED | Added side of a street attribute to location. |
| 3.13.0 | ADDED | Added avoid polygon and encoded polygon in the fleet profiles. |
| 3.13.0 | ADDED | New cluster service time strategy boundedSumStrategy. |
| 3.13.0 | ADDED | Support avoid polygon areas. |
| 3.13.0 | ADDED | Support side of a street. |
| 3.12.0 | ADDED | Added reload property to the vehicle shift. |
| 3.12.0 | ADDED | Vehicle reloading. |
| 3.10.0 | ADDED | Added routing mode property on car profile. |
| 3.10.0 | ADDED | Support for selecting the routing mode (fast, short) for car profile. |
| 3.9.0 | ADDED | Support for job task ordering by introducing the order property. |
| 3.8.0 | REMOVED | Optional(and deprecated) property problemId from solution model. |
| 3.8.0 | ADDED | Support for avoid street features (e.g. toll road), areas, street segments, zones, zone categories, zone identifiers and truck road types in routing calculations. |
| 3.7.0 | REMOVED | Error code E613610 as we enable territories in alternative locations for a job task. |
| 3.7.0 | ADDED | Support territories in alternative places for a job task. |
| 3.6 | CHANGED | The limit on the number of places of a job task is increased from 1 to 3 to support alternative places. |
| 3.6 | ADDED | Support alternative places for a job task. Up to three alternative locations are supported. |
| 3.5 | REMOVED | Error code E613607 as we enable supporting territories for complex jobs with multiple tasks. |
| 3.5 | ADDED | Support territories for complex jobs with multiple tasks. |
| 3.4 | ADDED | shiftIndex property to solution's tours. |
| 3.4 | ADDED | optional shiftIndex property to relations. |
| 3.4 | ADDED | Support for multiple vehicle shifts. Up to seven non-overlapping vehicle shifts are supported. |
| 3.4 | CHANGED | Vehicle type's property shifts was changed to allow up to 7 shifts per one vehicle. |
| 3.3 | ADDED | territories property to vehicle type. |
| 3.3 | ADDED | territoryIds property to job place. |
| 3.3 | ADDED | Support for territory planning where vehicles can be restricted to serve jobs in specific territories. A vehicle can serve different territories with different priorities and can be configured to stick to its territories only or to serve other territories, with lower priority, if other constraints allow. |
| 3.2 | ADDED | exclude property to vehicle profiles. |
| 3.2 | ADDED | Support for exclusion of specific country codes in ISO 3166-1 alpha-3 format from the tour planning. |
| 3.1 | ADDED | Support for clustering jobs, i.e. grouping of similar jobs into one or several job clusters, in order to ensure that they are assigned to the same stop if feasible and thus are served together. The customerId property can be used to group jobs for the same customer into the same cluster(s) if possible. |
| 3.1 | CHANGED | For the jobs in relation type tour, constraints are generally not checked so that the behavior is consistent with the other relation types. However, still there is no guarantee that all jobs specified in the relation can be assigned. |
| 3.1 | ADDED | Added the following properties: - clustering property to plan- customerId property to job |
| 3.0 | ADDED | Introduce time based termination criteria in configuration settings. |
| 3.0 | CHANGED | Changed the jobs schema:- rename places to tasks- introduce places property inside pickups and deliveries tasks |
| 3.0 | CHANGED | For the same running time, in most cases better solutions can be obtained with the current release compared to the previous release. |
| 3.0 | CHANGED | Users have more control over the running time required to get a solution. |
| 3.0 | CHANGED | Moved traffic to fleet. |
| 3.0 | REMOVED | Removed the following options: - id from the problem definition- waitingTime optimization setting- optimizations from configuration setting |
Updated 3 hours ago
Did this page help you?