v1

latestOpenAPI 3.0.0HERE Documentation License2026-07-142162791.8 MB

Shipments

Gets all shipments

Gets all shipments of the project.

get/shipments/v4

Query parameters

pageTokenstring

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

limitinteger

The number of items to return per page

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

Filter the results by shipment status

startedBeforestring date-time

Return only shipments that started before the specified timestamp

startedAfterstring date-time

Return only shipments that started after the specified timestamp

endedBeforestring date-time

Return only shipments that ended before the specified timestamp

endedAfterstring date-time

Return only shipments that ended after the specified timestamp

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

Shipment plan ID

Return only shipments that have been instantiated from the specified shipmentPlanId

shipmentIdstring

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

isSubShipmentboolean

Returns only shipments marked as subShipments

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

string

string[]

A paramater to specify field to sort by and order. The following format can be used: 'name:asc' sort by name in ascending order, 'shipmentId:desc' sort by shipmentId in descending order. Allowed fields to sort by: shipmentId, name, status, startedAt, createdAt, endedAt, providedEtd, providedEta, calculatedEtd.

Response

Response body contains an array of shipment 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

Total number of shipments for query

Example response

{
  "count": 1,
  "items": [
    {
      "autoStart": true,
      "description": "A shipment consisting of one segment",
      "name": "From Portugal to Panama",
      "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",
      "status": "pending",
      "subShipment": false
    }
  ],
  "limit": 100
}