Sign in

v1

latestOpenAPI 3.0.12026-07-2487135176.5 KB
Shipments

Retrieve a Shipment

View a shipment within the specified account.

get/public/v3/Shipments/{shipmentId}

Path parameters

shipmentIdstring required

shipmentId of the shipment.

Headers

x-tive-account-idinteger required

ID of the account the request will be made in.

Response

The requested shipment

shipmentIdstring nullable
publicShipmentIdstring nullable
deviceIdsstring[] nullable
autoCompleteboolean
shipFromDatestring date-time nullable
etaDatestring date-time nullable
autoCompleteMinutesDelayinteger
sharedUrlstring nullable
isSharedboolean nullable
isStartedboolean
isDepartedboolean
isCompletedboolean
trackerStartDelay'ZeroMinutes' | 'ThirtyMinutes' | 'OneHour' | 'OneAndHalfHours' | 'TwoHours' | 'FourHours'

The period of time the tracker should wait before measuring or transmitting data after the start button is pressed. This is ONLY for Solo Pro Devices.

mbolNumberstring nullable

The Master Bill of Lading Number associated to this shipment.

mbolCarrierScacstring nullable

The SCAC code of the carrier for the Master Bill of Lading Number associated to this shipment.