HERE Shipments API
The Shipments service manages shipments.A shipment describes a structure of a multimodal logistics journey. Shipments are useful whenthe lifetime of an asset one is tracking spans across multiple devices.A shipment consists of segments that span from a location to another. The segments and theirorigins and destinations must form a continuous chain of locations, that is the origin of a segmentmust match the destination of a previous segment. Each segment of the shipment may be assigned a`trackingId` that can vary between segments. Devices assigned to a shipment generate tracesand events for the entire shipment.The `shipmentId` of a shipment can be used in similar fashion as a `trackingId` in selectedAPIs. For example, one can query for shipment ***traces*** and ***events*** and associate ***aliases*** and***metadata*** to a shipment.Each shipment has one of the following statuses:* ***pending***: The shipment has not yet started.* ***ongoing***: The shipment has started and it has one segment ongoing.* ***completed***: The shipment has ended and all of its segments are completed.* ***cancelled***: The shipment has ended and it has one or more cancelled segments.HERE Tracking progresses the shipment automatically if each segment has been assigned a`trackingId` and the origin and destination locations contain a `geofenceId`. Each segment isstarted upon exiting the origin location of the segment and completed upon entering thedestination location of the segment. If the origin and the destination of a segment share thesame location (that is, dwelling in a single location), the segment will automatically bestarted after the previous segment was completed. To automatically start a segment whichfollows a dwelling segment, both the dwelling and following segment has to have the same`trackingId` assigned to them. If a segment does not have a device assigned, the user muststart and complete the segment manually.A new shipment should be instantiated for each separate logistical journey.Shipments that are still ongoing after two weeks are automatically cancelled.This time limit can be altered via `registry/v2/features` endpoint by changing`data.shipments.ongoingRetentionPeriod` configuration option.Shipments older than six months are automatically removed.Automatic shipment startup can be constrained to trigger only at time of shipment's `providedEtd`by defining an auto-start limit window via configuration options of`data.shipments.autoStartLimitBefore` and `data.shipments.autoStartLimitAfter` through`registry/v2/features` endpoint.With the auto-start limit window configured, pending shipments that have `providedEtd` set thatare not started within the limit window are automatically cancelled.
HERE Shipments API is one of 139 APIs that HERE publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Shipments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 11 operations across 6 paths. It is described by OpenAPI 3.2.0, at version 2.6.11.
Requests are made against 2 base URLs: https://tracking.hereapi.com/, https://tracking.api.here.com/.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 6
HERE Shipments API declares
6 security schemes
for authenticating requests.
An API key is passed in the query as apiKey (ApiKey).
It accepts HTTP bearer tokens (JWT) (Bearer).
It accepts HTTP bearer tokens (JWT) (UserToken).
It accepts HTTP bearer tokens (JWT) (ClientToken).
It accepts HTTP bearer tokens (JWT) (DeviceToken).
It uses HTTP oauth authentication (signedRequest).
ApiKey— A key generated specifically to authenticate API requests. For more information on how to get an API key, see the [Identity & Access Management Developer Guide…Bearer— A token obtained from a separate endpoint using client credentials and an OAuth 1.0a HMAC-SHA256 signed request. Users are authenticated using an OAuth 1.0 bea…UserToken— This token is obtained using user's realm, username and password and then further scoped to a specific project. First obtain access token from [/users/v2/login…ClientToken— This token is obtained using application's OAuth 2.0 credentials (key + secret) and then scoped to a specific project. Follow [instructions here](https://www.h…DeviceToken— This access token is obtained from [/v2/token endpoint](tag/Ingestion/paths/~1v2~1token/post) using a signed request. Note: Only a small subset of our endpoint…signedRequest— HERE Tracking requires that you sign your requests for tokens. The signature method uses the OAuth 1.0 standard. For more information on this standard, see the…
Paths & Operations 11
Across 6 paths, the API surfaces 11 operations — 2 DELETE, 6 GET, 2 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
The Shipments service manages shipments.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from HERE 12
Other APIs HERE publishes across the network.
This is an independent, third-party profile of HERE Shipments 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.