Set Shipment Devices

Set the list of devices for a shipment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

shipmentId of the shipment.

Body Params
boolean

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

boolean

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.

devices
array of strings | null

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

devices
Headers
int32
required

ID of the account the request will be made in.

Responses
200

Shipment devices updated.

400

Unable to update shipment devices. See response message for details.

401

Unauthorized

500

Internal Server Error

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!