Create a Shipment

post

https://api.tive.com/public/v3/Shipments

Create a shipment within the specified account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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:

shipmentId

string

required

length ≥ 1

The unique identifier of your shipment.

customFields

array of objects | null

Custom informational field that apply to your organization. Shipments allow for up to five custom fields.

customFields

shipmentLegs

array of objects

required

For Shipments that make more than one stop, multiple Legs can be created for each stop that the shipment will make. Addresses are required for To/From for each leg, either by sending To/FromLocationId or To/FromCoordinates and To/FromAddress.

shipmentLegs*

endOfTripConfiguration

object

commodities

array of int32s | null

List of commodity ids to attach to the shipment.

commodities

startNow

boolean

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

Headers

x-tive-account-id

int32

required

ID of the account the request will be made in.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

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

401

Unauthorized

Language

Loading…

Response

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

201The created shipment publicShipmentId