HERE

HERE Shipments API

The Shipments service manages shipments. A shipment describes a structure of a multimodal logistics journey. Shipments are useful when the 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 their origins and destinations must form a continuous chain of locations, that is the origin of a segment must 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 traces and events for the entire shipment. The `shipmentId` of a shipment can be used in similar fashion as a `trackingId` in selected APIs. 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 is started upon exiting the origin location of the segment and completed upon entering the destination location of the segment. If the origin and the destination of a segment share the same location (that is, dwelling in a single location), the segment will automatically be started after the previous segment was completed. To automatically start a segment which follows 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 must start 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 that are not started within the limit window are automatically cancelled.

GitHub OpenAPI
Business capability
Logistics Operations Management BC-520.50

Operations 11

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /shipments/v4/health Check the Shipments service health · Gets service health #
Ask an LLM
“Is the HERE Tracking Shipments service up right now?”
“Can I ping the Shipments service before sending it requests?”
Tell an agent
Check the health of the Shipments service.
Tell me whether the Shipments service is healthy.
GET /shipments/v4/version Get the Shipments service version · Gets service version #
Ask an LLM
“What version of the Shipments service is deployed?”
“Which build of the Shipments service am I talking to?”
Tell an agent
Get the version of the Shipments service.
Show me which Shipments service version is running.
POST /shipments/v4 Create a shipment with segments · Creates a shipment #
Ask an LLM
“How do I set up a multi-leg shipment with a tracker on each leg?”
“Can a shipment start automatically when created?”
Tell an agent
Create shipment {name} with segments {segments}.
Create a shipment for order {extOrderId} with segments {segments} and autostart {autoStart}.
GET /shipments/v4 List shipments in a project · Gets all shipments #
Ask an LLM
“Which shipments are currently in progress?”
“Can I find shipments by external order ID?”
Tell an agent
List all shipments in project {projectId}.
Find shipments with status {status}.
DELETE /shipments/v4 Delete every shipment in a project · Deletes all shipments #
Ask an LLM
“Can I delete all shipments in a project at once?”
“What confirmation does wiping every shipment require?”
Tell an agent destructive · confirm first
Delete all shipments in project {projectId} with x-confirm {confirm}.
Remove every shipment, confirming with {confirm}.
GET /shipments/v4/{shipmentId} Get one shipment's details · Gets a shipment details #
Ask an LLM
“What is the status of a particular shipment?”
“Can I see all segments of one shipment?”
Tell an agent
Get shipment {shipmentId}.
Show the status and segments of shipment {shipmentId}.
PATCH /shipments/v4/{shipmentId} Update a shipment's details · Updates a shipment details #
Ask an LLM
“Can I change a shipment's name or status after creating it?”
“Does updating segments replace the whole segment list?”
Tell an agent
Update shipment {shipmentId}.
Partially update the details of shipment {shipmentId}.
DELETE /shipments/v4/{shipmentId} Delete one shipment and its data · Deletes a shipment #
Ask an LLM
“Does deleting a shipment also remove its events and associations?”
“Can I delete a single shipment?”
Tell an agent destructive · confirm first
Delete shipment {shipmentId}.
Remove shipment {shipmentId} with all its data.
GET /shipments/v4/{shipmentId}/{segmentId} Get one shipment segment · Gets a segment details #
Ask an LLM
“What are the details of one leg of a shipment?”
“Which tracker is assigned to a specific shipment segment?”
Tell an agent
Get segment {segmentId} of shipment {shipmentId}.
Show leg {segmentId} in shipment {shipmentId}.
PATCH /shipments/v4/{shipmentId}/{segmentId} Update one shipment segment · Updates a segment details #
Ask an LLM
“Can I reassign a different tracker to one leg of a shipment?”
“How does changing a segment status affect the other segments?”
Tell an agent
Set segment {segmentId} of shipment {shipmentId} to status {status}.
Assign tracker {trackingId} to segment {segmentId} of {shipmentId}.
GET /shipments/v4/{trackingId}/segments List shipment segments assigned to a device · Gets segments assigned to a device #
Ask an LLM
“Which shipment legs is a tracker assigned to?”
“Can I filter a device's segments by status?”
Tell an agent
List segments assigned to device {trackingId}.
Show tracker {trackingId}'s segments with status {status}.

Documentation

📖
Documentation
https://docs.here.com/identity-and-access-management/docs
📖
APIReference
https://docs.here.com/identity-and-access-management/reference
📖
Documentation
https://docs.here.com/data-api/docs
📖
APIReference
https://docs.here.com/data-api/reference
📖
Documentation
https://docs.here.com/usage/docs
📖
APIReference
https://docs.here.com/usage/reference
📖
Documentation
https://docs.here.com/destination-weather/docs
📖
APIReference
https://docs.here.com/destination-weather/reference
📖
Documentation
https://docs.here.com/ev-products/docs
📖
APIReference
https://docs.here.com/ev-products/reference
📖
Documentation
https://docs.here.com/fuel-prices/docs
📖
APIReference
https://docs.here.com/fuel-prices/reference
📖
Documentation
https://docs.here.com/geocoding-and-search/docs
📖
APIReference
https://docs.here.com/geocoding-and-search/reference
📖
Documentation
https://docs.here.com/routing/docs
📖
APIReference
https://docs.here.com/routing/reference
📖
Documentation
https://docs.here.com/positioning/docs
📖
APIReference
https://docs.here.com/positioning/reference
📖
Documentation
https://docs.here.com/indoor-map/docs
📖
APIReference
https://docs.here.com/indoor-map/reference
📖
Documentation
https://docs.here.com/transit/docs
📖
APIReference
https://docs.here.com/transit/reference
📖
Documentation
https://docs.here.com/map-attributes/docs
📖
APIReference
https://docs.here.com/map-attributes/reference
📖
Documentation
https://docs.here.com/map-rendering/docs
📖
APIReference
https://docs.here.com/map-rendering/reference
📖
Documentation
https://docs.here.com/workspace/docs
📖
APIReference
https://docs.here.com/workspace/reference
📖
Documentation
https://docs.here.com/tour-planning/docs
📖
APIReference
https://docs.here.com/tour-planning/reference
📖
Documentation
https://docs.here.com/tracking/docs
📖
APIReference
https://docs.here.com/tracking/reference
📖
Documentation
https://docs.here.com/traffic-api/docs
📖
APIReference
https://docs.here.com/traffic-api/reference
📖
Documentation
https://docs.here.com/wego-pro/docs
📖
APIReference
https://docs.here.com/wego-pro/reference

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/here/refs/heads/main/openapi/here-shipments-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/here:here-shipments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

here-shipments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 2.6.11
  title: HERE Tracking Shipments API
  description: 'HERE Tracking is a cloud product designed to address location tracking problems for a wide range of Location IoT industry verticals.


    HERE Tracking also includes end-user mobile and web applications that can be used to demonstrate the product.'
  license:
    name: HERE Documentation License
    url: https://legal.here.com/en-gb/terms/documentation-license
servers:
- url: https://tracking.hereapi.com/
- url: https://tracking.api.here.com/
tags:


# --- truncated at 32 KB (119 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/here/refs/heads/main/openapi/here-shipments-api-openapi.yml