PRproject44
LTL: Tracking

Updates an LTL shipment

Use this endpoint to update a shipment. To achieve this, this endpoint deletes the current shipment and creates a new shipment on which it will begin tracking. This updates how we track the shipment but will not affect the dispatch with the carrier. Note that you must pass the entire details for the shipment, just as you would on a POST. Note that you only need to update a shipment when the carrier, time, or date has changed.

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

<ul><li> id </li><li><b> capacityProviderAccountGroup: </b></li><ul><li><b> accounts: </b></li><ul><li> code </li></ul></ul><li><b> shipmentIdentifiers: </b></li><ul><li> type </li><li> value </li><li> primaryForType (if more than one shipment identifier of the same type) </li></ul><li><b> shipmentStops: </b> (two stops of types ORIGIN and DESTINATION) </li><ul><li> stopType </li><li><b> location: </b></li><ul><li><b> address: </b></li><ul><li> postalCode </li><li> addressLines </li><li> city </li><li> state </li></ul><li><b> contact: </b></li><ul><li> companyName </li></ul></ul><li><b> appointmentWindow: </b></li><ul><li> startDateTime </li><li> endDateTime </li></ul></ul></ul>
put/api/v4/ltl/trackedshipments/{id}

Request

Path parameters

idinteger required

The project44-generated id of the LTL tracked shipment you wish to update.

Request body

idinteger

The project44-generated id of the LTL shipment. This may be provided when creating a tracked shipment only if a tracked shipment does not exist with this id but a shipment record does exist in project44's system with this id. This enables linking a dispatched shipment that initially failed to track to its tracking information by passing the id from dispatch. This id will always be returned in the shipment confirmation and may be used in subsequent API calls to reference a shipment.

ltlLegIdstring uuid

The project44-generated id that is the UUID equivalent of id. The same rules apply to this value as applies to the id.

masterShipmentIdstring uuid

The project44-generated id that connects multi-leg shipments agnostic of mode.

Response

OK

Changes

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