v1

latestOpenAPI 3.0.0HERE Documentation License2026-07-142162791.8 MB

Shipments

Gets a segment details

Gets details of a segment identified by the segmentId.

get/shipments/v4/{shipmentId}/{segmentId}

Response

Success.

The segment information was returned

calculatedEtastring date-time

Calculated ETA for the segment

calculatedEtdstring date-time

Calculated ETD for the segment

createdAtstring date-time

Timestamp indicating when this segment created

descriptionstring

Description of the segment

destinationstring

Destination location of this segment

endedAtstring date-time

Timestamp indicating when this segment ended

namestring

Name of the segment

originstring

Origin location of this segment

providedEtastring date-time

User provided ETA for the segment

providedEtdstring date-time

User provided ETD for the segment

segmentIdstring

Segment ID

startedAtstring date-time

Timestamp indicating when this segment started

status'pending' | 'ongoing' | 'completed' | 'cancelled'

Status of the segment

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. Alternatively, a valid shipmentId may be used.

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",
  "endedAt": "2020-05-27T11:40:01Z",
  "name": "Truck transport",
  "origin": "LOC-54531862-f87a-4b70-99a4-0e8224a56be4",
  "segmentId": "SEG-156986fa-1ed9-42ab-a022-9ac1a70ae137",
  "startedAt": "2020-05-27T11:40:01Z",
  "status": "pending",
  "trackingId": "HERE-540bb24b-0d57-4f8c-aeaf-6c91cd0aff8d",
  "transportMode": "truck"
}