GET shipments/v4

X-Request-Id (string, header, optional)

ID used for correlating requests within HERE Tracking. Used for logging and error reporting. Must be a valid UUIDv4.

createdAfter (string, query, optional)

Return only shipments that have been created after specified timestamp

createdBefore (string, query, optional)

Return only shipments that have been created before specified timestamp

endedAfter (string, query, optional)

Return only shipments that ended after the specified timestamp

endedBefore (string, query, optional)

Return only shipments that ended before the specified timestamp

isSubShipment (boolean, query, optional)

Returns only shipments marked as subShipments

limit (integer, query, optional, default: 100)

The number of items to return per page

Constraints: {'minimum': 1, 'maximum': 100}

name (string, query, optional)

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

pageToken (string, query, optional)

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

projectId (string, query, optional)

Constraints: {'minLength': 1, 'maxLength': 50}

shipmentId (string, query, optional)

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

shipmentPlanId (string, query, optional)

Return only shipments that have been instantiated from the specified `shipmentPlanId`

Constraints: {'pattern': '^SHPP-[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$'}

sort (?, query, optional)

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.

startedAfter (string, query, optional)

Return only shipments that started after the specified timestamp

startedBefore (string, query, optional)

Return only shipments that started before the specified timestamp

status (string, query, optional)

Filter the results by shipment status

Constraints: {'enum': ['pending', 'ongoing', 'completed', 'cancelled']}