v1

latestOpenAPI 3.0.0HERE Documentation License2026-07-142162791.8 MB

Shipments

Gets a segment plan details

Gets details of a segment plan identified by the segmentPlanId.

get/shipments/v4/plans/{shipmentPlanId}/{segmentPlanId}

Response

Success.

The segment plan information was returned

descriptionstring

Description of the segment

destinationstring

Destination location of this segment

durationSinteger

Segment duration in seconds.

namestring

Name of the segment

originstring

Origin location of this segment

segmentPlanIdstring

Segment plan ID

trackingIdstring

This is a unique ID associated with the device data in HERE Tracking. For physical devices the trackingId gets assigned to a device when the device is claimed by a user, and for virtual devices it is an external device ID along with the device project appId.

transportMode'car' | 'truck' | 'sea' | 'air' | 'undefined'

Transport mode of the segment

Example response

{
  "description": "From factory to port",
  "destination": "LOC-7b6b15cc-2307-4875-9f66-99deb5227e92",
  "durationS": 28800,
  "name": "Truck transport",
  "origin": "LOC-54531862-f87a-4b70-99a4-0e8224a56be4",
  "segmentPlanId": "SEGP-3253bff4-97ba-4dfa-866c-fa8703902fcf",
  "trackingId": "HERE-540bb24b-0d57-4f8c-aeaf-6c91cd0aff8d",
  "transportMode": "truck"
}