v1

latestOpenAPI 3.0.0HERE Documentation License2026-07-142162791.8 MB

Shipments

Lists all shipment plans

Gets all shipment plans of the project.

get/shipments/v4/plans

Query parameters

pageTokenstring

A token from the previously returned response to retrieve the specified page.

limitinteger

The number of items to return per page

namestring

Filter shipments by name. Matching is case-insensitive. The following wildcards can be used: '*' matches any number of any characters, '?' matches any single character.

shipmentPlanIdstring

Return only shipment plans that have been instantiated from the specified shipmentPlanId Matching is case-insensitive. The following wildcards can be used: '*' matches any number of any characters, '?' matches any single character.

locationIdstring

Return only shipments that have been instantiated from the specified locationId

createdBeforestring date-time

Return only shipments that have been created before specified timestamp

createdAfterstring date-time

Return only shipments that have been created after specified timestamp

isSubShipmentboolean

Returns only shipments marked as subShipments

string

string[]

A paramater to specify field to sort by and order. Allowed fields to sort by: shipmentPlanId, name, createdAt

Response

Response body contains an array of shipment plan objects, count indicates the number of returned items, limit indicates the requested maximum amount of records to be returned and pageToken is the next page token if available.

countinteger required

Number of items returned in the response

limitinteger required

Maximum number of items as specified in request

nextPageTokenstring

Token to fetch the next page (if exists)

totalinteger required

Total count of matching results

Example response

{
  "items": [
    {
      "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
    }
  ]
}