PRproject44
LTL: Push Tracking

Create status updates for a shipment.

<h4><b>Required Fields</h4></b> <ul><li><b> customerAccount: </b></li><ul><li> accountIdentifier </li></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><li> primaryForType (if more than one shipment identifier of the same type)</li></ul><li> statusCode </li><li><b> location: </b>(if statusCode is 'ARRIVED_AT_TERMINAL' or 'DEPARTED_TERMINAL')</li><ul><li><b> address: </b>(if location provided)</li><ul><li> city (if location provided)</li><li> state (if location provided and country is US)</li><li> country (if location provided and country is not US. Default: US)</li></ul></ul><li><b> deliveryAppointmentWindow: </b>(if statusCode is 'UPDATED_DELIVERY_APPT')</li><li> timestamp </li></ul>
post/api/v4/capacityproviders/ltl/shipments/statusupdates

Request

Request body

sourceType'API' | 'EDI'

The original type of data source for where this status update originated from. (default: API)

statusCode'READY_FOR_PICKUP' | 'UPDATED_PICKUP_APPT' | 'EXCEPTION' | 'PICKED_UP' | 'ARRIVED_AT_TERMINAL' | 'REWEIGHT_RECLASS' | 'INFO' | 'UPDATED_DELIVERY_APPT' | 'DEPARTED_TERMINAL' | 'OUT_FOR_DELIVERY' | 'DELIVERED'

The project44 status code for this status update. This field must always be populated.

stopNumberinteger

The stop number, where '1' is the origin and the destination has the largest number, with any stops in between ordered by appointment time.

stopType'ORIGIN' | 'DESTINATION' | 'TERMINAL'

The type of the shipment stop to which this status update corresponds, if any. For example, a status update with code 'AT_STOP' will typically have this field populated with the stop type the vehicle is at.

terminalCodestring

The service center's code. For example, the capacity provider's service center in Miami may have a code like 'MIA-123' or 'MIA'. This should match a stop code of one of the shipment stop's stop codes.

timestampstring

The timestamp of this status update in the time zone of the location (format: yyyy-MM-dd'T'HH:mm:ssZ). If this status update has no location, the time zone should be UTC.

Response

Accepted

Changes

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