Sign in

v1

latestOpenAPI 3.0.12026-07-2487135176.5 KB
Shipments

Set Shipment Devices

Set the list of devices for a shipment.

put/public/v3/Shipments/{shipmentId}/devices

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.

Response

Shipment devices updated.