Gets all shipments

get deprecated

https://tracking.hereapi.com/shipments/v4

Gets all shipments of the project.

Query Params

pageToken

string

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

limit

integer

1 to 100

Defaults to 100

The number of items to return per page

status

string

enum

Filter the results by shipment status

Allowed:

startedBefore

date-time

Return only shipments that started before the specified timestamp

startedAfter

date-time

Return only shipments that started after the specified timestamp

endedBefore

date-time

Return only shipments that ended before the specified timestamp

endedAfter

date-time

Return only shipments that ended after the specified timestamp

name

string

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

shipmentPlanId

string

Return only shipments that have been instantiated from the specified shipmentPlanId

shipmentId

string

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

extOrderId

string

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

isSubShipment

boolean

Returns only shipments marked as subShipments

createdBefore

date-time

Return only shipments that have been created before specified timestamp

createdAfter

date-time

Return only shipments that have been created after specified timestamp

sort

A parameter 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, extOrderId, name, status, startedAt, createdAt, endedAt, providedEtd, providedEta, calculatedEtd, calculatedEta.

projectId

string

length between 1 and 50

Project ID. Any HERE Tracking user must be a member of a Tracking project. The project ID can be implicitly resolved if the user calling the API is a member of a single project. If the user is a member of multiple projects, the projectId query parameter needs to be specified explicitly.

Headers

X-Request-Id

uuid

ID used for correlating requests within HERE Tracking. Used for logging and error reporting.

Must be a valid UUIDv4.

Responses

200Response 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.

400Bad request The request object is in an incorrect format or has values that are invalid or out of range. If available, further error details are provided in the response body.

401Unauthorized The request did not provide correct authentication details

403Forbidden The account does not have the correct privileges