LTL: Tracking

Start tracking an LTL shipment

Use this POST call to start a tracking job, initializing LTL tracking. The tracking job will run for a given duration (designated with the startDateTime and endDateTime parameters), gathering updates from the carrier and reference numbers detailed in the API call. Once a tracking update has been pulled from the carrier into the project44 tracking job, you can access the information via the GET requests below this endpoint. Note that if your dispatch was done through project44, you do not need to initialize tracking. project44 will implicitly start tracking based on the data provided in the dispatch.

<h4><b>Required Fields</h4></b> <ul><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><b>NOTE:</b> The appointmentWindow object in shipmentStops does not support a localTimeZoneIdentifier due to an automated project44 process that detects time zone based on the stop's location. Please make sure to provide startDateTime and endDateTime in local time.
post/api/v4/ltl/trackedshipments

Request

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

Created

Changes

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