BlogContact Us
API Reference

Create a Shipment Template

post
https://api.tive.com/public/v3/ShipmentTemplates

Create a shipment template within the specified account.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1

The unique name of the shipment template.

string | null

A description of the shipment template use case.

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 | null

For Shipments that make more than one stop, multiple Legs can be created for each stop that the shipment will make.

shipmentLegs
endOfTripConfiguration
object
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:
commodities
array of int32s | null

List of commodity ids to attach to the shipment template.

commodities
Headers
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 template. See response message for details.

401

Unauthorized

Updated 7 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 7 months ago