Start a Shipment

patch

https://api.tive.com/public/v3/Shipments/{shipmentId}/start

Start the specified shipment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

shipmentId

string

required

shipmentId of the shipment.

Body Params

skipDeviceLocationCheck

boolean

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

closeActiveShipments

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

trackerStartDelay

string

enum

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.

Allowed:

Headers

x-tive-account-id

int32

required

ID of the account the request will be made in.

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200

The shipment has been started

400

Unable to start the shipment. See response message for details.

401

Unauthorized

500

Internal Server Error

Language

Loading…

Response

Click Try It! to start a request and see the response here!