Sign in

v1

latestOpenAPI 3.0.12026-07-2487135176.5 KB
Shipments

Start a Shipment

Start the specified shipment.

patch/public/v3/Shipments/{shipmentId}/start

Path parameters

shipmentIdstring required

shipmentId of the shipment.

Headers

x-tive-account-idinteger required

ID of the account the request will be made in.

Request body

skipDeviceLocationCheckboolean

Determines whether a shipment should start even if the tracker location does not match the shipment start location. Defaults to false.

closeActiveShipmentsboolean

Close other active shipments related to the trackers being added to this shipment. When closing an existing shipment the new shipment will start at the current time. Defaults to false.

devicesstring[] nullable

A list of device IDs associated with the shipment. Note, to <emp>start</emp> a shipment you must specify at least one device.

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.

Response

The shipment has been started