v1

latestOpenAPI 3.0.12026-07-2487135176.5 KB

Shipments

Get Shipment Tracker Data

View the measured tracker data on the specified shipment.

get/public/v3/Shipments/{shipmentId}/trackerData

Path parameters

shipmentIdstring required

shipmentId of the shipment.

Query parameters

Startstring date-time

<a href="https://developers.tive.com/docs/timestamps">UTC</a> start time for the date range of results to be returned. Defaults to shipment start datetime.

Endstring date-time

<a href="https://developers.tive.com/docs/timestamps">UTC</a> end time for the date range of results to be returned. Defaults to now if the shipment isn't completed and the completed date if it has.

FilterByProcessingTimeboolean

Whether or not to use the provided start/end time to filter the data by transmission and processing time instead of by record time. Defaults to false.

PageSizeinteger

The number of results to retrieve. Default and maximum is 50.

PageNumberinteger

The page number to use. This is needed when there are more objects than the max page size. The default is 1.

Headers

x-tive-account-idinteger required

ID of the account the request will be made in.

Response

The requested trackers for shipment

totalRecordsinteger

pageNumberinteger

pageSizeinteger

nextstring nullable

previousstring nullable