v1

latestOpenAPI 3.0.0HERE Documentation License2026-07-142162791.8 MB

Shipments

Gets a shipment plan details

Gets details of a shipment plan identified by the shipmentPlanId.

get/shipments/v4/plans/{shipmentPlanId}

Response

Success.

The shipment plan information was returned

autoStartboolean

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

createdAtstring date-time

Timestamp indicating when the shipment plan has been created

descriptionstring

Description of the shipment

namestring

Name of the shipment

ruleIdsstring[]

Array of ruleIds to associate with the shipment

shipmentPlanIdstring required

Shipment plan ID

subShipmentboolean

Flag telling if shipment is a subShipment.

Example response

{
  "autoStart": true,
  "createdAt": "2020-05-27T11:40:01Z",
  "description": "A shipment consisting of four segments",
  "name": "From Portugal to Panama",
  "ruleIds": [
    "49716c18-9858-40bb-842a-15bf2ed02c64",
    "ccc540b3-b2c8-4914-b00f-de518cb56e75"
  ],
  "segments": [
    {
      "description": "From factory to port",
      "destination": "LOC-7b6b15cc-2307-4875-9f66-99deb5227e92",
      "durationS": 10800,
      "name": "Truck transport",
      "origin": "LOC-54531862-f87a-4b70-99a4-0e8224a56be4",
      "segmentPlanId": "e19cec4f-445e-41d0-9f0e-d1304ea707d1",
      "trackingId": "HERE-540bb24b-0d57-4f8c-aeaf-6c91cd0aff8d",
      "transportMode": "truck"
    },
    {
      "description": "From port to another port",
      "destination": "LOC-a2dc2c70-cc3e-4fa5-ac77-4c63558e7f97",
      "durationS": 129600,
      "name": "Marine transport",
      "origin": "LOC-7b6b15cc-2307-4875-9f66-99deb5227e92",
      "segmentPlanId": "6c668d6b-1eeb-46c2-ba12-31265c346c04",
      "trackingId": "VRTR-8b9fd950-ce19-4aaf-98d5-840a76652658",
      "transportMode": "sea"
    },
    {
      "description": "From port to storage",
      "destination": "LOC-733deb91-efa3-41b6-9003-92845866b511",
      "durationS": 7200,
      "name": "Truck transport",
      "origin": "LOC-a2dc2c70-cc3e-4fa5-ac77-4c63558e7f97",
      "segmentPlanId": "b331cc64-0c83-4347-8a08-bf984675832f",
      "trackingId": "HERE-540bb24b-0d57-4f8c-aeaf-6c91cd0aff8d",
      "transportMode": "truck"
    }
  ],
  "shipmentPlanId": "SHPP-730b08fe-ec44-4e6f-b2b0-1d3cc264981c",
  "subShipment": false
}