PRproject44
TL: Tracking

Update a truckload shipment

Use this endpoint to update a truckload shipment. <p><b>Example:</b> You can update location fields or appointment windows to reflect changes with this endpoint.</p>Note that tracking information updates are currently not supported. This includes shipmentIdentifiers, capacityProviderAccountGroup, and apiConfiguration changes.* It is suggested to first get the current shipment object from the GET shipment endpoint, make the desired modifications, and then PUT the modified shipment to this endpoint. After the modified shipment is successfully submitted, the updated stops, attributes, shipping details etc. will be applied and used in tracking from then on. If a shipment PUT request comes in with only GeoCoordinates, it is possible that a street address will not be returned in the response.

<br/><h4><b>Required Fields</h4></b>

<ul><li><b> carrierIdentifier: </b></li><ul><li> type </li><li> value </li></ul><li><b> shipmentIdentifiers: </b></li><ul><li> type </li><li> value </li></ul><li><b> shipmentStops: </b> (at least two) </li><ul><li> stopNumber </li><li><b> appointmentWindow: </b></li><ul><li> startDateTime </li><li> endDateTime </li></ul><li><b> location: </b></li><ul><li><b> address: </b> (if no geoCoordinates provided) </li><ul><li> postalCode </li><li> addressLines </li><li> city </li><li> state (for USA, Mexico, and Canada) </li></ul><li><b> contact: </b></li><ul><li> companyName </li></ul></ul><li><b> geoCoordinates: </b> (if no address provided) </li></li><ul><li> latitude </li><li> longitude </li></ul></ul><li><b> capacityProviderAccountGroup: </b> (by a few capacity providers) </li><ul><li><b> accounts: </b></li><ul><li> code </li></ul></ul><li><b> equipmentIdentifiers: </b> (by most capacity providers) </li><ul><li> type </li><li> value </li></ul></ul>
put/api/v4/tl/shipments/{id}

Request

Path parameters

idinteger required

The project44-generated id of the shipment being updated.

Request body

idinteger

The project44-generated id for the shipment. This may not be provided when creating a shipment, but will always be returned in the shipment confirmation. This id may be used in subsequent API calls to reference a shipment.

idleDurationinteger

Computed value representing how long (in minutes) shipment is being Idle. This value is available while whole status history is being requested.

masterShipmentIdstring uuid

The project44-generated id for tracking an intermodal shipment. This id may be used in subsequent API calls to reference a shipment.

scopestring[]
shipmentLegIdstring uuid

The project44-generated id for the truckload shipment. This id may be used in subsequent API calls to reference a shipment.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.