v1

latestOpenAPI 3.0.0HERE Documentation License2026-07-142162791.8 MB

Shipments

Gets a shipment details

Gets details of a specific shipment identified by the shipmentId.

get/shipments/v4/{shipmentId}

Response

Success.

The shipment information was returned

autoStartboolean required

A boolean parameter defining whether the shipment starts upon exiting the first origin location.

calculatedEtastring date-time

Calculated ETA for the shipment

calculatedEtdstring date-time

Calculated ETD for the shipment

createdAtstring date-time

Timestamp indicating when the shipment has been created

descriptionstring

Description of the shipment

endedAtstring date-time

Timestamp indicating when the shipment ended

namestring

Name of the shipment

providedEtastring date-time

User provided ETA for the shipment

providedEtdstring date-time

User provided ETD for the shipment

ruleIdsstring[]

Array of ruleIds to associate with the shipment

shipmentIdstring required

Shipment ID

shipmentPlanIdstring

A shipment plan's id that the shipment was generated from.

startedAtstring date-time

Timestamp indicating when the shipment started

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

Status of the shipment

subShipmentboolean

Flag telling if shipment is a subShipment.

Example response

{
  "autoStart": true,
  "description": "A shipment consisting of one segment",
  "name": "From Portugal to Panama",
  "ruleIds": [
    "712dde2c-20e6-4903-82f1-0beb0dd9e4bd",
    "6d1da24b-5187-42ab-9eb5-1e43c61b6bae"
  ],
  "segments": [
    {
      "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"
    }
  ],
  "shipmentId": "SHP-d306beb9-e110-450e-9f81-3db9de1ac001",
  "shipmentPlanId": "SHPP-de2bd93d-a371-4e22-801a-528238d1a33a",
  "status": "pending",
  "subShipment": false
}