v1

latestOpenAPI 3.0.12026-07-2487135176.5 KB
Shipments

Get Shipment Alerts

View the alerts that were triggered on the specified shipment.

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

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.

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 alerts for shipment

totalRecordsinteger
pageNumberinteger
pageSizeinteger
nextstring nullable
previousstring nullable