createTruckloadShipmentEvent

post/api/v4/capacityproviders/tl/shipments/{shipmentLegId}/events
SecurityoAuth2
Request
path Parameters
shipmentLegId
required
string <uuid>

shipmentLegId

Request Body schema:
required

shipmentEvent

dateTime
string

The time when this event occurred. If relevant, the offset will be relative to where the event occurred, otherwise will be in UTC. Will only be populated for events that have already happened.

Array of objects (TrackedShipmentDateTime)

A list of times retrieved from different sources.

description
string

A human readable description of this event. Optional response field.

estimateDateTime
string

The estimated time that this event is likely to occur. Only populated if event has not occurred yet.

estimateLastCalculatedDateTime
string

The time when project44 last calculated the estimate for this event. Only populated if event has not occurred yet.

plannedDateTime
string

The planned time when this event is scheduled to occur. If plannedEndDateTime is set, this is the start of the planned window of time for the event.

plannedEndDateTime
string

The end of the planned window of time for the event.

receivedDateTime
string

The time when project44 received or calculated this event. Will only be populated for events that have already happened.

routeSegmentId
string <uuid>

If relevant, this will be populated with the id of a route segment on which this event occurred. This can be used to associate the event with a specific vehicle.

stopId
string <uuid>

If relevant, this will be populated with the id of the stop to which this event relates.

type
string

The type of event that occurred. Will always be populated.

Enum: "UNKNOWN" "TRACKING_INITIATE" "TRACKING_START" "ARRIVAL_AT_STOP" "DEPARTURE_FROM_STOP" "LOAD_ONTO_VEHICLE" "UNLOAD_FROM_VEHICLE" "TRACKING_END_DUE_TO_TIMEOUT" "TRACKING_END_BY_USER" "TRACKING_COMPLETE" "GATE_IN" "GATE_OUT" "FLIGHT_BOOKING" "MANIFEST" "RECEIVE_FROM_SHIPPER" … 58 more
Responses
200

OK

400

Invalid request

401

Invalid or missing credentials

403

User not authorized to perform this operation

Request samples
{
  • "dateTime": "string",
  • "dateTimes": [
    ],
  • "description": "string",
  • "estimateDateTime": "string",
  • "estimateLastCalculatedDateTime": "string",
  • "plannedDateTime": "string",
  • "plannedEndDateTime": "string",
  • "receivedDateTime": "string",
  • "routeSegmentId": "a5aad6c5-e2d6-4a7a-8912-ea0254639352",
  • "stopId": "dd775241-8a00-4193-b07c-f3e4740fdc43",
  • "type": "UNKNOWN"
}
Response samples
{
  • "dateTime": "string",
  • "dateTimes": [
    ],
  • "description": "string",
  • "estimateDateTime": "string",
  • "estimateLastCalculatedDateTime": "string",
  • "plannedDateTime": "string",
  • "plannedEndDateTime": "string",
  • "receivedDateTime": "string",
  • "routeSegmentId": "a5aad6c5-e2d6-4a7a-8912-ea0254639352",
  • "stopId": "dd775241-8a00-4193-b07c-f3e4740fdc43",
  • "type": "UNKNOWN"
}

Was this page helpful?