Update a Shipment Template

put

https://api.tive.com/public/v3/ShipmentTemplates/{shipmentTemplateId}

Update a shipment template within the specified account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

shipmentTemplateId

string

required

ID of the shipment template.

Body Params

name

string

required

length ≥ 1

The unique name of the shipment template.

description

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

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:

commodities

array of int32s | null

List of commodity ids to attach to the shipment template.

commodities

Headers

x-tive-account-id

int32

required

ID of the account the request will be made in.

Responses

200

The shipment template has been updated

400

Unable to update the shipment template. See response message for details.

401

Unauthorized

Language

Loading…

Response

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