GET /shipments/v4/plans

here.com:tracking

Summary: Lists all shipment plans
Operation ID: —
Auth: unknown
Description

Gets all shipment plans of the project.

Parameters (11)

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

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}

locationId (string, query, optional)

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

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}

shipmentPlanId (string, query, optional)

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.

sort (?, query, optional)

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

No probe data for this endpoint yet.