v1

latestOpenAPI 3.0.12026-07-2487135176.5 KB

Shipments

Retrieve Shipment Status

View the most recent device measurement of the specified shipment.

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

shipmentIdstring required

shipmentId of the shipment.

loadTemperatureCalculationsboolean

Loads MeanKineticTemperature, StandardDeviationTemperature, and DegreeMinutesTemperature values. Default false

degreeMinutesMinTempnumber double

Minimum Temp for DegreeMinutesTemperature calculation.

degreeMinutesMaxTempnumber double

Maximum Temp for DegreeMinutesTemperature calculation.

x-tive-account-idinteger required

ID of the account the request will be made in.

The requested shipment status

shipmentIdstring nullable

publicShipmentIdstring nullable

totalDistancenumber double

Total distance for the shipment (in KM).

distanceTravellednumber double

Distance this shipment has traveled so far (in KM).

distanceRemainingnumber double

Distance this shipment has remaining (in KM).

lastUpdatedAtstring date-time nullable

startedAtstring date-time nullable

startedByUserstring nullable

departedAtstring date-time nullable

deliveredAtstring date-time nullable

completedAtstring date-time nullable

completedByUserstring nullable

currentTemperaturenumber double nullable

currentLightnumber double nullable

currentHumiditynumber double nullable

currentPressurenumber double nullable

currentProbeTemperaturenumber double nullable

meanKineticTemperaturenumber double nullable

standardDeviationTemperaturenumber double nullable

degreeMinutesTemperaturenumber double nullable