GuidesAPI Reference
Guides

API Changes

Release 3.52.0

Added

  • [ALPHA] Added stopProfile to VehicleShift to deprecate stopConfig.profile

Release 3.51.0

Added

  • [ALPHA] Added maxIntraStopDistance

Release 3.50.0

Added

  • Added intraStopDistance to Stop
  • Added intraStopDistance to Statistic
  • Added arrival to Interval
  • Added intraStop to Timing

Release 3.49.0

Removed

  • [ALPHA] Removed traffic from ignoreRouteViolations

Release 3.48.2

Added

  • [ALPHA] Added vehicleTypeIds to ParkingPlace

Changed

  • [ALPHA] Increased max limit of parking places from 1 to 10

Release 3.47.0

Added

  • Added details to UnassignedJobReason in the Solution

Release 3.45.6

Changed

  • Changed maximum limit for shiftTime and maxDrivingTime from 86400 to 604800 seconds (7 days)

Release 3.45.5

Changed

  • Changed maximum limit for maxDistanceToNeighbor in dbscan stop configuration from 75 to 500 meters

Release 3.45.0

Added

  • [ALPHA] Added profile to stopConfig for walk optimized clustering

Release 3.44.5

Added

  • [ALPHA] Added excess costs for duration

Release 3.43.1

Added

  • [ALPHA] Added minimizeSoftTimeWindowViolations advanced objective

Release 3.41.0

Added

  • [ALPHA] Added excess costs feature

Release 3.40.0

Added

  • [ALPHA] Added recharges to VehicleShift

Release 3.39.0

Added

  • [ALPHA] Added tieBreak advanced objective

Release 3.38.1

Changed

  • [ALPHA] Changed min limit for max driving/working duty rule

Release 3.37.0

Added

  • [ALPHA] Added dutyRule to VehicleRestTime

Release 3.36.1

Removed

  • Removed category from BusOptions

Release 3.36.0

Added

  • [ALPHA] Added maxDrivingTime to VehicleLimits

Release 3.35.2

Added

  • Added axleCount to VehicleOptions, CarOptions and TaxiOptions

Release 3.35.0

Added

  • [ALPHA] Added routeDetails with polyline to Configuration
  • [ALPHA] Added fuel to VehicleType

Release 3.34.0

Added

  • Added weightPerAxleGroup to VehicleOptions
  • Added trailerCount to VehicleOptions and CarOptions
  • Added seasonalClosure to AvoidFeatures
  • Added speed to pedestrian profile options
  • Added areas to Exclude
  • Added taxi profile

Release 3.31.2

Changed

  • Updated documentation for the upload matrix endpoint

Release 3.31.1

Changed

  • Updated documentation for the upload matrix endpoint

Release 3.31.0

Added

  • Added policy to vehicle break
  • [ALPHA] Added TimeWindows property to JobPlace
  • [ALPHA] Allow pudos in relations
  • [ALPHA] Added houseKeyId property to JobPlace
  • Added id to the Location
  • [ALPHA] Increased maximum job priority levels to five
  • [ALPHA] Added endpoint for uploading custom matrices (Please contact your regional HERE representative to get access to this endpoint)
  • [ALPHA] Added serveInClusters advanced objective

Changed

  • [ALPHA] Used MatrixOrigin model instead of Location in custom matrix origins array

Release 3.30.1

Added

  • Added validation in case relation has mixing of groups inside

Release 3.30.0

Added

  • [ALPHA] Added matrix to vehicle profile

Release 3.29.0

Added

  • [ALPHA] Added minimizeTourOverlap advanced objective
  • Added position to the JobTask

Changed

  • Increased maximum number of breaks in a shift to 5
  • Marked order in JobTask as deprecated

Release 3.28.1

Changed

  • Changed tolerance range for VisuallyAppealingTours objective

Release 3.28.0

Changed

  • Changed notice's code type from enum to string

Release 3.27.0

Added

  • [ALPHA] Added advancedObjectives

Release 3.26.0

Added

  • Added groups to the Plan
  • Added stopConfig to the VehicleShift

Release 3.25.2

Changed

  • Changed description of UNREACHABLE_IN_RELATION_CONSTRAINT

Release 3.25.1

Changed

  • conflictingCategories maximum allowed size has been reduced from 1000 to 100

Release 3.25.0

Added

  • Added groupId in the JobPlace
  • Added maxTimeOnVehicle to the Job
  • Added experimentalFeatures array to problem configuration
  • Added minCount in the VehicleStopsLimit
  • Added category to the Job
  • Added mixingRestrictions to the VehicleShift
  • Added restTimes in the VehicleShift

Changed

  • location is not required anymore on the VehiclePlace

Release 3.24.4

Added

  • Added notices for unreachable locations

Release 3.24.3

Changed

  • Improved the descriptions for the JobId and PlaceTag parameters.

Release 3.24.2

Changed

  • Created RoutingLocation for each location object used in the problem

Release 3.24.1

Changed

  • Added separate error code for too many jobs, too many vehicle types and for general api validation

Release 3.24.0

Added

  • Added ignoreRouteViolations to vehicle profile

Release 3.23.0

Added

  • Added notices to the solution

Release 3.22.0

Changed

  • The limit async job tasks is increased from 3000 to 6000

Release 3.21.0

Added

  • Added traffic mode to vehicle profile
  • Added speed cap to vehicle profile

Release 3.20.0

Added

  • Vehicle-dependent stop base duration feature
  • Added speedFactor to vehicle type

Release 3.19.0

Added

  • Added timeOffset property to vehicle shift start

Release 3.18.0

Added

  • Added vehicleIds array to vehicle type

Release 3.17.0

Added

  • Added optimizeTaskOrder objective
  • Added two fleet profiles: bus and privateBus

Release 3.16.0

Added

  • Added two objectives: minimizeDistance, minimizeDuration

Release 3.15.0

Added

  • Added category to truck options
  • Added distance in solution

Release 3.14.0

Added

  • Maximum number of stops attribute
  • objectives attribute
  • Added name hint attribute to location

Release 3.13.0

Added

  • Added side of a street attribute to location
  • Added avoid polygon and encoded polygon in the fleet profiles
  • New cluster service time strategy boundedSumStrategy

Release 3.12.0

Added

  • Added reload property to the vehicle shift

Release 3.10.0

Added

  • Added routing mode property on car profile.

Release 3.9.0

Added

  • Support for job task ordering by introducing the order property

Release 3.8.0

Removed

  • Optional(and deprecated) property problemId from solution model.

Release 3.7.0

Removed

  • Error code E613610 as we enable territories in alternative locations for a job task.

Release 3.6

Changed

  • The limit on the number of places of a job task is increased from 1 to 3 to support alternative places.

Release 3.5

Removed

  • Error code E613607 as we enable supporting territories for complex jobs with multiple tasks

Release 3.4

Added

  • shiftIndex property to solution's tours
  • optional shiftIndex property to relations

Changed

  • Vehicle type's property shifts was changed to allow up to 7 shifts per one vehicle.

Release 3.3

Added

  • territories property to vehicle type.
  • territoryIds property to job place.

Release 3.2

Added

  • exclude property to vehicle profiles.

Release 3.1

Added

  • clustering property to plan
  • customerId property to job

Release 3.0

Added

  • introduce time based termination criteria in configuration settings

Changed

  • change jobs schema:
    • rename places to tasks
    • introduce places property inside pickups and deliveries tasks
  • move traffic to fleet

Removed

  • remove id from the problem definition.
  • remove waitingTime optimization setting.
  • remove optimizations from configuration setting