HERE Asynchronous API
Endpoints that support asynchronous request flows, allowing for delayed processing and responses to API requests.
HERE Asynchronous API is one of 139 APIs that HERE publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Asynchronous. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 5 operations across 5 paths, and defines 192 schemas. It is described by OpenAPI 3.2.0, at version 3.61.1.
Requests are made against a single base URL, https://tourplanning.hereapi.com/v3.
5 operations
5 paths
192 schemas
2 GET2 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
HERE Asynchronous API declares
2 security schemes
for authenticating requests.
An API key is passed in the query as apikey (ApiKey).
It accepts HTTP bearer tokens (JWT) (Bearer).
By default, every request must be authenticated.
ApiKey— The API authentication key. For more information on how to get an API key, see [Identity and Access Management - Developer Guide](https://docs.here.com/identit…Bearer— This token is obtained from a separate endpoint using client credentials and an OAuth 1.0a HMAC-SHA256 signed request. For more information on how to get a bea…
Paths & Operations 5
Across 5 paths, the API surfaces 5 operations — 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Asynchronous 5
Endpoints that support asynchronous request flows, allowing for delayed processing and responses to API requests.
POST
/problems/async
Submit a Vehicle Routing Problem to solve it asynchronously
GET
/status/{statusId}
Get status update by Id
GET
/problems/{problemId}/solution
Get solution by problem or status Id
PUT
/problems/{problemId}/cancel
Cancel a problem by problem or status Id
POST
/matrices
ALPHA Upload a Routing Matrix
Schemas 192
The contract defines 192 schemas that model the data the API accepts and returns. The most detailed are VehicleType (14 properties), CarProfile (12 properties), VehicleOptions (12 properties), ScooterProfile (11 properties). Each schema is shown below with its type and property counts.
AvoidTruckRoadType
string
A truck road type identifier that routes will avoid going through. A truck road type identifier is associated with roads that have additional regulations appli…
PudoPlace
object
BETA Specifies the location and time for serving the pick-up and drop-off (PUDO) activity. This ensures that each PUDO is served at the correct location and wi…
5 properties
2 required
Duration
integer
Represents a time duration in seconds. Used to specify service times at job locations, waiting times, driving times, breaks, and other time-based constraints i…
VehicleShiftMixingRestrictions
object
Enables the prevention of mixing conflicting jobs within a single vehicle.
2 properties
2 required
PolygonArea
object
A polygon defined as a list of coordinates. The polygon is automatically closed, so repeating the first vertex is not required.
2 properties
2 required
Matrix
object
ALPHA Routing matrix for vehicle profile. The matrix has to contain 2 flat arrays, travelTimes and distances. Each array represents a 2D matrix where rows corr…
4 properties
3 required
ChargingStation
object
ALPHA Specifies a shared place where vehicle can recharge.
5 properties
3 required
ExcessCosts
object
BETA Specifies limits on distance, stops count etc. Penalties have to be paid in case those limits are violated.
4 properties
ViolationMapping
array
List of items for mapping certain violated restrictions to specific error codes in the matrix. This mapping can classify restrictions or blockages while still…
TunnelCategory
string
Specifies the tunnel category to restrict certain route streets. The route will pass only through tunnels of a less strict category.
DbscanStopConfig
object
5 properties
2 required
ProfileName
string
Specifies the name of the profile. Avoid assigning real-life identifiers, such as a vehicle license plate Id or personal name as the profileName of the routing…
JobPositionOrdered
object
In order of priority, puts the job task lower than first but higher than unordered and last tasks. Assignments labeled as ordered must also include an associat…
2 properties
2 required
Stop
object
Represents a [specific geographical location](https://docs.here.com/tour-planning/docs/solutionstop) where a vehicle is scheduled to perform one or more activi…
9 properties
3 required
TieBreakObj
object
ALPHA A single objective as a part of the TieBreak objective. Note that the objective must not be a composite objective itself. It is, e.g., not possible to pu…
3 properties
1 required
ViolationMappingItem
Generic base type for violation mappings. Violation mappings belong to either of two categories. Mappings belonging to the same category are evaluated together…
AuthErrorResponse
object
2 properties
2 required
MinimizeTours
object
ALPHA Minimizes the number of used vehicles
1 property
1 required
VehicleBreakPolicy
string
Specifies the policy for vehicle break. allowAtTheEnd: The vehicle break will be scheduled even if the vehicle arrives at the depot before the break's time win…
MixingRestrictionSet
object
A set of restrictions on mixing jobs based on their categories
2 properties
VehicleFuel
object
Fuel parameters to be used for calculating consumption and related CO2 emission. These are not taken into account for optimization. Note: speedFactor parameter…
5 properties
2 required
Termination
object
Defines the conditions under which the optimization algorithm stops running.
3 properties
2 required
Relation
object
Defines how specific jobs are related to each other and how they should be completed by a specific vehicle (defined by the ${vehicleType}${sequenceIndex} patte…
4 properties
3 required
BalanceMaxLoad
object
ALPHA An objective to balance max load across all tours.
2 properties
2 required
JobTask
object
Refers to a specific action within a job, such as picking up or delivering items at designated locations. Each job can include up to three pickup tasks and up…
4 properties
2 required
VehicleMaxStopsCountLimit
object
Hard limit on the maximum number of stops in a shift.
1 property
1 required
ViolationMappingItemRestriction
object
Allows the mapping of violations of selected restrictions. Mapping of violated restrictions is supported for transport mode truck. For the type of restriction,…
7 properties
2 required
PrivateBusProfile
object
Route calculation for buses that are not allowed to drive through the bus-only roads.
11 properties
2 required
QuadraticPenalty
object
ALPHA Quadratic penalty function that increases exponentially with larger deviations from the preferred time window. Provides flexibility for small delays but…
1 property
1 required
JobPositionFirst
object
Puts the job task at the beginning of the tour, executed immediately after departure.
1 property
1 required
MaxDurationStrategy
object
Sets the cluster's total duration to the longest job duration. This strategy is useful when multiple tasks for the same customer don't significantly increase o…
1 property
1 required
MaximizeTerritoryJobs
object
ALPHA An objective to achieve desired jobs distribution between vehicles considering the territories in which these vehicles operate.
1 property
1 required
TaxiOptions
object
Specifies taxi profile options.
4 properties
1 required
BoundingBoxArea
object
A bounding box defined by two longitudes and two latitudes.
5 properties
5 required
TooManyRequestsResponse
object
2 properties
2 required
HouseKeysMaxDurationStrategy
object
Takes max time duration from all activities and applies it once.
1 property
1 required
RelationType
string
Defines how jobs are related to each other and how they should be completed by a specific vehicle. The following relation types are supported: sequence: Jobs m…
MultiObjective
array
ALPHA Enables the definition of multiple objectives with equal priority, ensuring that each objective is considered equally during the optimization process.
ScooterOptions
object
Specifies scooter profile options.
2 properties
ServiceTimeStrategy
Controls how the duration or service time of job clusters is determined. Selecting a service strategy type is useful in scenarios where multiple jobs are serve…
Plan
object
[Set of jobs](https://docs.here.com/tour-planning/docs/problemplan) that need to be completed as part of a tour. This includes details such as job locations fo…
6 properties
1 required
Timing
object
Contains detailed time consumption information for various activity types during a tour. All durations are in seconds and represent the total time spent on dif…
7 properties
5 required
ErrorResponse
object
6 properties
6 required
PedestrianProfile
object
Routing calculations for pedestrians. The departureTime property allows to specify a custom date-time for which traffic optimization in routing calculations sh…
11 properties
2 required
PedestrianOptions
object
Specifies pedestrian profile options.
1 property
Statistic
object
Provides [metrics](https://docs.here.com/tour-planning/docs/solutionstatistic) about the performance and efficiency of vehicles across all tours. These metrics…
9 properties
4 required
HouseKeysConfig
object
ALPHA Configures the house keys feature which controls how service time is calculated when multiple jobs with the same houseKeyId are served at the same stop.
1 property
1 required
AsTieBreakObjective
ViolationMappingOptionalField
string
Defines how a specific violation attribute should be handled within a violation mapping. Use: include: the violated restriction is added to a mapped category i…
Tour
object
Represents a [pre-optimized route](https://docs.here.com/tour-planning/docs/solutionlist-of-tours) that has been completed by a single vehicle, encompassing al…
5 properties
5 required
OptimizeTaskOrder
object
Deprecated, please use OptimizeTaskPosition objective instead. An objective to control order of job task activities in the tour. When specified, the task order…
1 property
1 required
StopConfig
ALPHA Configures how stops are created. Specifies how multiple jobs located close to each other can be grouped into a single stop. Please consult the developer…
BicycleProfile
object
Routing calculations for bicycles. The departureTime property allows to specify a custom date-time for which traffic optimization in routing calculations shall…
10 properties
2 required
AvoidArea
Defines an explicit area to avoid/exclude when calculating the routes. Areas to be avoided/excluded can be specified by boundingBoxes or polygons (as encoded p…
VehicleDutyRestTime
ALPHA Defines duty rest time
MinimizeCost
object
Minimizes the total solution cost
2 properties
1 required
JobCostOverride
object
ALPHA Per-job cost override for a specific job ID. When matched, the override cost is used directly.
2 properties
2 required
Penalty
ALPHA Specifies the penalty function applied when the preferred (soft) time window is violated. The penalty score is an abstract numeric value used by the opti…
ParkingPlace
object
ALPHA Specifies parking place data.
3 properties
1 required
VehicleCosts
object
Defines different vehicle costs per unit.
6 properties
MinimizeDuration
object
An objective to minimize total duration calculated as the sum of all tour durations.
1 property
1 required
AvoidFeatures
string
A routing feature to avoid during route calculation. Available avoid feature options: tollRoad motorway ferry tunnel dirtRoad controlledAccessHighway carShuttl…
TaxiProfile
object
Route calculation for taxis. This profile takes into account taxi restricted streets as well as streets reserved for exclusive taxi access. It does not, howeve…
11 properties
2 required
MaxTimeOnVehicle
integer
The maximum amount of time in seconds the job is allowed to stay on the vehicle. Constrains the maximum time the job can be on the vehicle in the solution. Thi…
VehicleBreak
object
A vehicle break time. It starts in the declared time window and can end after the time window (based on the duration). Either a rest time or a break can be spe…
4 properties
2 required
VehicleCharging
object
ALPHA Specifies vehicle charging properties.
7 properties
VehicleIds
array
List of available vehicles. Can be used to assign individual vehicle to the tour. In other case amount property should be used. Each identifier must be unique…
SoftTimeWindow
object
ALPHA Represents a single soft constraint time window that allows flexibility when minor delays are acceptable. Consists of a hard constraint boundary (absolut…
2 properties
2 required
Objective
VehicleFixedDutyRestTime
object
ALPHA Defines type of duty rest time configuration with fixed duration Disclaimer: This is an experimental feature under development To enable it, add restTime…
5 properties
2 required
RouteDetails
object
ALPHA Represents the specific information about the path a vehicle takes between the current stop and the previous one, in the form of a [polyline representati…
1 property
Location
object
Represents a geospatial location defined by latitude and longitude coordinates in WGS-84 format. Used to specify vehicle start and end positions, job locations…
3 properties
VehicleFixedDurationRestTime
object
BETA Defines type of rest time configuration with fixed duration
3 properties
3 required
RouteDetailsConfiguration
array
Include [route details](https://docs.here.com/tour-planning/docs/polylines) between each stop in the solution, in the [flexible polyline](https://github.com/he…
VehicleType
object
Represents a vehicle type.
14 properties
4 required
TimeWindows
array
Represents multiple hard constraint time windows. Each time window specifies a time period during which an activity (such as a delivery or pickup) must start.…
Territory
object
Conceptually represents a geographical region that can be used to restrict the geographical area in which vehicles operate. If defined, vehicles will only/prim…
2 properties
1 required
LargeMatrix
object
ALPHA Routing matrix for vehicle profile. The matrix has to contain 2 flat arrays, travelTimes and distances. Each array represents a 2D matrix where rows corr…
4 properties
3 required
VehicleWorkingRestTime
BETA Defines working rest time
ServerErrorResponse
object
6 properties
6 required
BoundedSumStrategy
object
Ensures the total duration of a job cluster is the sum of individual job durations, capped at a maximum limit. This strategy is useful for grouping similar job…
2 properties
2 required
EncodedPolygonArea
object
A polygon defined as a [Flexible Polyline](https://github.com/heremaps/flexible-polyline) encoded string. The polygon is automatically closed, so repeating the…
2 properties
2 required
CarProfile
object
Routing calculations for cars. The departureTime property allows to specify a custom date-time for which traffic optimization in routing calculations shall be…
12 properties
2 required
LinearPenalty
object
ALPHA Linear penalty function that increases at a constant rate for each unit of time deviation from the preferred time window. This penalty type imposes costs…
1 property
1 required
JobTasks
object
Tasks refer to specific actions that need to be performed as part of a job, such as pickups or deliveries at designated locations. Each job can consist of up t…
2 properties
JobPositionLast
object
Puts the job task at the end of the tour. If an assignment is labeled with the last position, the API prioritizes it as the final task to be handled after all…
1 property
1 required
VehicleShift
object
Specifies how vehicle should operate in one work shift.
9 properties
1 required
TruckProfile
object
Route calculation for trucks. This mode considers truck limitations on links and uses different speed assumptions when calculating the route. The departureTime…
11 properties
2 required
OptimizeTourCount
object
Optimizes the number of vehicles used in the solution. The action parameter determines whether to maximize or minimize the vehicle count
2 properties
2 required
Profile
JobPlace
object
Refers to a specific location where one or more pickup or delivery activities occur. A place is defined by geographical coordinates (latitude and longitude) an…
9 properties
2 required
VehicleLimits
object
Contains constraints applied to a vehicle type.
5 properties
MaximizePriorityJobs
object
ALPHA An objective to maximize assignment of prioritized jobs.
1 property
1 required
SideOfStreetHint
object
Provides a hint indicating the preferred side of the street for a job location. This ensures vehicles stop on the most convenient or safest side of the road to…
3 properties
2 required
Id
string
A unique identifier of an entity. Avoid referencing any confidential or personal information as part of the Id.
MaximizeTours
object
ALPHA Maximizes the number of used vehicles.
1 property
1 required
EagerDeliveryOptions
object
ALPHA Specifies if the eager delivery feature is active. Here 'eager' means that the delivery driver will try to perform jobs 'on the way there' and not 'on th…
4 properties
1 required
VisuallyAppealingTours
object
ALPHA An objective to produce a more visually appealing tours in contrast to cost/balancing considerations
4 properties
1 required
PlaceTag
string
An optional free-text field submitted as part of the problem request, providing additional information related to the task's place for easier identification or…
AsyncProblemCancellationStatus
object
Represents the response body returned after submitting a problem cancellation request.
4 properties
4 required
Unit
array
Represents multidimensional units of measure for vehicle capacity and job demand. Can specify volume, mass, weight, number of items, or other accumulative meas…
Activity
object
An activity is defined as a planned task to be performed at a specific location and time within a stop on a tour. Each activity has properties like jobId, type…
7 properties
2 required
TimeWindow
array
Represents a single hard constraint time window. The first element is the lower bound (earliest start time) and the second element is the upper bound (latest s…
IgnoreRouteViolations
array
Defines vehicle routing violations (like closed road, no-through zone) that should be ignored.
Category
string
Specifies a job category used in conjunction with vehicle mixing restrictions to prevent incompatible goods from being transported together. Categories are use…
ScooterProfile
object
Routing calculations for scooters. The departureTime property allows to specify a custom date-time for which traffic optimization in routing calculations shall…
11 properties
2 required
MatrixUploadResponse
object
Response of the uploaded matrix
1 property
1 required
HouseKeysBoundedSumStrategy
object
Takes a bounded sum (sum with upper limit) for all activities with the same house key.
2 properties
2 required
ExperimentalFeatures
array
Lists the enabled [experimental features](https://docs.here.com/tour-planning/docs/experimental-features) that are still under development. These experimental…
VehicleMinStopsCountLimit
object
ALPHA Hard limit on the minimum number of stops in a shift. Please consult the developer guide for more information before using this feature. To enable it, ad…
1 property
1 required
SpeedCap
number
Specifies the maximum speed, in m/s, which the vehicle should not exceed. This parameter affects route duration. Notes: Car and Truck profile updates route ETA…
VehiclePlace
object
Represents a depot: a place where a vehicle starts or ends.
4 properties
1 required
Parking
object
ALPHA Represents a parking space or car park with id that vehicles can use during their tours.
2 properties
2 required
TieBreak
object
ALPHA A hierarchical objective that allows ties in a higher-level objective to be broken by a lower-level objective
2 properties
2 required
StopConfigurationLimits
object
ALPHA Configures limits for a single stop. To enable it, add clusterNearby flag to experimentalFeatures configuration in the problem.
1 property
BusOptions
object
Specifies bus profile options. Supported only if the locations' distribution radius is less than 490 km. If not added, only generic bus restrictions are applie…
11 properties
VehicleStopsLimit
object
Limits on the amount of stops a vehicle of that type can perform in a shift. A stop is only counted if at least one pickup or delivery is performed as part of…
2 properties
AdvancedObjective
AvoidSegment
string
A segment identifier that routes will avoid going through. Each entry has the following structure: {segmentId}({direction})? The individual parts are: segmentI…
VehicleCategory
string
Specifies the category of vehicle. If not specified, undefined value is used. undefined: The vehicle category is undefined and no special considerations are ta…
JobPositionInTour
Specifies the position of the job task in the tour. Use the position property to control the serving order of tasks within a tour. Job tasks with a position pr…
Schedule
object
Specifies the expected arrival and departure times at a particular stop.
2 properties
2 required
MatrixId
string
ALPHA Unique identifier (UUID) of the uploaded matrix
MatrixOrigin
An ordered list of origins used in the routing matrix
MinimizeUnassigned
object
Minimizes the number of unassigned jobs
1 property
1 required
VehicleJobCost
object
ALPHA Per-job cost function on vehicle costs.
2 properties
1 required
AvoidZone
string
A routing zone identifier that routes will avoid going through. For example the identifier here:cm:envzone:2 references the Berlin Umweltzone environmental zon…
Problem
object
A [problem](https://docs.here.com/tour-planning/docs/problem) JSON file that defines the fleet, jobs, and configuration for optimizing tours, which is passed s…
5 properties
2 required
Fleet
object
Represents the [collection of vehicles](https://docs.here.com/tour-planning/docs/problemfleet) used for completing the planned tours. Each vehicle in the fleet…
3 properties
2 required
ViolationMappingCategory
string
The category number assigned to this violation mapping item. Two categories are supported, with values 1 and 2 available to categorize the mapping items.
Traffic
object
Traffic specific parameters.
1 property
1 required
TruckOptions
Specifies truck profile options. Supported only if the locations' distribution radius is less than 490 km. If not added, only generic truck restrictions are ap…
RouteViolation
string
Defines route violation. Violation happens only if no feasible route without violations between i and j was found - all: Includes all violations, such as traff…
DateAndTime
string
Represents a date-time value formatted according to RFC3339. Used to specify precise timestamps for job time windows, vehicle shift start and end times, break…
ServeInClusters
object
ALPHA An objective to serve jobs in clusters
2 properties
1 required
UnassignedJobReason
object
Explains the circumstances under which a job was not assigned. For example, no vehicles with the required skill were available to complete the job.
3 properties
2 required
UnassignedJobDetail
object
ALPHA Details about job unassignment such as vehicle id, shift index. This can help to analyze how to modify the problem definition to decrease amount of unass…
2 properties
2 required
Solution
object
Contains detailed information about how to efficiently solve a vehicle routing problem by completing a set of jobs with a fleet of vehicles. The solution inclu…
4 properties
1 required
StopConfiguration
object
ALPHA Configures how stops are created. Specifies how multiple jobs located close to each other can be grouped into a single stop.
2 properties
1 required
MinimizeDistance
object
An objective to minimize total distance.
1 property
1 required
Group
object
BETA Represents a [collection of jobs](https://docs.here.com/tour-planning/docs/group-jobs) linked by criteria such as geographic proximity, delivery windows,…
3 properties
1 required
MinimizeTourOverlap
object
ALPHA An objective to produce less overlapping tours, that are more geographically separated and more compact
4 properties
1 required
FixedDurationStrategy
object
Sets the cluster's total duration to a predefined value, regardless of individual job durations. This strategy helps in planning and optimizing service time fo…
2 properties
2 required
AvoidRoutes
object
Avoid routes that violate these properties.
6 properties
HouseKeysFixedDurationStrategy
object
Sets the total duration to a fixed value, regardless of individual job durations.
2 properties
2 required
TimeWindowsViolations
object
ALPHA Indicates the total number and the sum of seconds by which all [soft time windows](https://docs.here.com/tour-planning/docs/soft-time-windows) were viola…
2 properties
2 required
Skills
array
A list of skills required by a job or provided by a vehicle type. Only vehicles with all the skills required by a job can serve that job. Use skills to match s…
CountryCode
string
ISO-3166-1 alpha-3 country code.
ViolationMappingItemTraffic
object
Allows the mapping of traffic related blockages. Mapping of traffic blockages is supported for transport modes car and truck.
3 properties
2 required
BalanceOptions
object
ALPHA Specifies balance objective options. At the moment, it uses coefficient of variation as balancing measure.
1 property
1 required
VehicleReload
object
Specifies a place where vehicle can load or unload cargo.
4 properties
2 required
MinimizeSoftTimeWindowViolations
object
ALPHA An objective to minimize soft time window violations.
1 property
1 required
ProblemId
string
A unique identifier for the problem.
ActivityType
string
The available types of planned tasks to be performed at a specific location and time as part of a stop.
AsyncActionSubmissionResult
object
The response body containing the request status UUID and the status update URL used to track the completion status of a valid asynchronous problem that you sub…
2 properties
2 required
ShiftIndex
integer
Index of a vehicle shift used to distinguish between different shifts for the same vehicle. Since a vehicle can have at most 7 shifts, the value must be betwee…
Configuration
object
Provides a way to define various additional settings and constraints for solving vehicle routing problems or permit the use of experimental features. For more…
3 properties
Notice
object
A notice provides additional information about the request, such as hints on how to improve the problem formulation. This information can help you understand p…
4 properties
2 required
Compartment
object
ALPHA a definition of a compartment representing part of the vehicle load
2 properties
2 required
BalanceActivities
object
ALPHA An objective to balance activities across all tours.
2 properties
2 required
BusProfile
object
Route calculation for buses that are allowed to drive through the bus-only roads.
11 properties
2 required
BalanceDistance
object
ALPHA An objective to balance distance across all tours.
2 properties
2 required
AsyncActionCompletionStatus
object
Represents the response body with the problem calculation status, returned after submitting a request for the status of an asynchronous problem calculation.
3 properties
1 required
VehicleDrivingRestTime
BETA Defines driving rest time
JobPositionAny
object
Puts the job task at any place in the tour (also between ordered jobs) but not before the first position and not after the last position. This designation perm…
1 property
1 required
ViolationMappingItemAvoidAreasAndSegments
object
Allows the mapping of user specified avoidance of areas or individual segments. This type of mapping is supported for transport modes car and truck.
2 properties
2 required
HouseKeysStrategy
Specifies the duration strategy for house keys.
Exclude
object
Defines properties which will be strictly excluded from route calculation.
2 properties
TourOrder
object
ALPHA Deprecated, use OptimizeTaskPosition instead. An objective to control order of job activities in the tour.
2 properties
2 required
Interval
object
Represents an activity interval.
3 properties
2 required
SoftTime
object
ALPHA Represents a single soft time window instance where time unit is defined in the RFC3339 format.
3 properties
1 required
MatrixOriginId
object
Specifies the origin location used in custom matrix.
2 properties
2 required
JobCostRate
number
ALPHA A per-job cost rate. Used as the base rate in per-job cost calculation and as the override rate for specific job-vehicle pairs.
ExcessCostsField
object
Specifies limits on a solution metric and penalties to be paid in case those limits are violated.
4 properties
4 required
BalanceDuration
object
ALPHA An objective to balance duration across all tours.
2 properties
2 required
Violations
object
ALPHA Contains information about tour violations.
1 property
CostStatistics
object
Breakdown of cost into individual components. Fields are only present when the corresponding cost source is configured on the vehicle and the value is non-zero.
6 properties
Coordinate
object
2 properties
2 required
OptimizeTaskPosition
object
An objective to control position of job task activities in the tour. When specified, the task position is considered as a soft constraint and the solver tries…
2 properties
1 required
CarOptions
object
Specifies car profile options.
3 properties
ShippedHazardousGoods
string
List of hazardous materials in the vehicle. explosive: Explosive material gas: Gas flammable: Flammable material combustible: Combustible material organic: Org…
Job
object
Represents a job to be served by any vehicle, taking into account specific properties such as location, duration, demand, time windows, skills, and so on. A jo…
8 properties
2 required
VehicleOptions
object
12 properties
UnassignedJob
object
Specifies an unassigned job and outlines [possible causes of unassignment](https://docs.here.com/tour-planning/docs/troubleshoot-unassigned-jobs).
2 properties
2 required
Shared
object
ALPHA Represents a set of shared resources, such as parking places and charging stations, that can be utilized by multiple vehicles during their tours.
2 properties
VehicleInitialCharge
object
ALPHA Specifies vehicle charging properties.
2 properties
2 required
VehicleRestTime
object
BETA Defines rest times for a vehicle shift for driving, working and duty. Either a rest time or a break can be specified.
3 properties
RoutingLocation
object
Represents a geographic location with coordinates and optional routing hints. Used to specify vehicle depot locations, job sites, break locations, charging sta…
5 properties
WeightPerAxleGroup
object
Specifies the weights of different axle groups, like single and tandem axles. This allows specification of axle weights in a more fine-grained way than weightP…
5 properties
Pudo
object
BETA Represents a specific location called [PUDO (or pick-up and drop-off point)](https://docs.here.com/tour-planning/docs/group-jobsjob-groups-with-pudos) whe…
3 properties
3 required
AvoidZoneCategory
string
Specify avoidance of entire category of routing zones, with the provision to add individual exceptions.
ExcessCostStatistics
object
Excess costs broken down by metric. Fields are only present when the corresponding limit is configured and the excess cost is non-zero.
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from HERE 12
Other APIs HERE publishes across the network.
HERE Geocoding and Search API
HERE Autosuggest API
HERE Tour Planning API
HERE Public Transit API
HERE Destination Weather API
HERE Map Tile API
HERE Map Image API
HERE Tracking API
HERE Positioning API
HERE Parking API
HERE Platform Data API
HERE HD Live Map
#Asynchronous
Where this information came from
This is an independent, third-party profile of HERE Asynchronous API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.