Sign in

v1

latestOpenAPI 3.0.12026-07-2487135176.5 KB
Shipments

Create a Shipment

Create a shipment within the specified account.

post/public/v3/Shipments

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.

shipmentIdstring required

The unique identifier of your shipment.

commoditiesinteger[] nullable

List of commodity ids to attach to the shipment.

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.

startNowboolean

Specify whether the shipment should start immediately on successful creation. Defaults to false when not specified.

Response

The created shipment publicShipmentId

integer required