GuidesAPI Reference
API Reference

Lists all shipment plans

get deprecated
https://tracking.hereapi.com/shipments/v4/plans

Gets all shipment plans of the project.

Query Params
string

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

integer
1 to 100
Defaults to 100

The number of items to return per page

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.

string

Return only shipment plans that have been instantiated from the specified shipmentPlanId 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.

string

Return only shipments that have been instantiated from the specified locationId

date-time

Return only shipments that have been created before specified timestamp

date-time

Return only shipments that have been created after specified timestamp

boolean

Returns only shipments marked as subShipments

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

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
uuid

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

Must be a valid UUIDv4.

Responses

Updated 2 months ago

Language
Credentials
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 2 months ago