Appendix

LTL Shipment Event Types

Below are the available Event Types for LTL shipments and the descriptions for each Event Type.

Event Type	Description
`ARRIVAL_AT_STOP`	The shipment has arrived at a stop.
`DELAYED`	The shipment is delayed.
`DELIVERY`	The shipment has been delivered.
`DELIVERY` and `EXCEPTION`	The shipment has been delivered with an exception.
`DELIVERY_MISSED`	The shipment delivery was missed.
`DEPARTURE_FROM_STOP`	The vehicle transporting the shipment has left the stop.
`EXCEPTION`	There is an exception for the shipment.
`EXCEPTION_LATE_DEPARTURE`	The shipment missed its departure time at the stop.
`EXCEPTION_MISSED_CONNECTION`	The shipment missed its connection.
`HELD`	The shipment is held at a location.
`INFO`	Shipment exception. See the `event.description` for more information on this exception.
`OUT_FOR_DELIVERY`	The shipment is out for delivery to the destination.
`PICKED_UP`	The shipment has been picked up from a stop.
`PICKUP_MISSED`	The time window to pickup the shipment has been missed.
`TRACKING_END_BY_USER`	Tracking of the shipment has been canceled by the shipper.
`TRACKING_END_DUE_TO_TIMEOUT`	Shipment tracking has ended because the appointment window for deliv- ery has ended.
`TRACKING_INITIATE`	The LTL shipment has been created in project44's system. Assumed to always be non-null.
`TRACKING_START`	Tracking of the LTL shipment has started.
`TRACKING_STOP`	Tracking of the LTL shipment has stopped.

All Event Types can sometimes return an ETA or ATA. Please connect with your project44 Customer Success Manager to identify which event types return an ETA or ATA most often for your shipments.

LTL Shipment State Types

Below are the accepted State Type values for LTL shipments and the Event Types that trigger a State Type start or stop.

State Type	Start Event	Stop Event
`SCHEDULED`	`TRACKING_START`	Any next event.
`IN_TRANSIT`	`DEPARTURE_FROM_STOP`	Next event that has a different `routeSegmentId`, `stopId`, or maps to a different state type.
`AT_STOP`	`ARRIVAL_AT_STOP`	Next event that has a different `routeSegmentId`, `stopId`, or maps to a different state type.
`COMPLETED`	`DELIVERY`, `TRACKING_END_BY_USER`, `TRACKING_END_DUE_TO_TIMEOUT`, `TRACKING_STOP`	N/A

LTL Shipment Stop Types

Below are the available Stop Types for LTL shipments and the descriptions for each Stop Type.

Stop Type	Details
`ORIGIN`	Where the truck is filled by the shipper with the goods to be transported.
`PICKUP`	Where the empty vehicle is loaded with the shipment.
`TRANSFER`	Where the shipment is transfered.
`DESTINATION`	Where the shipment is finally delivered to.

Error Response Codes

This Appendix describes the schema and fields of the standard project44 API Error Response.

Below, find the API Error Response Schema:

400 Invalid Request

{
  "httpStatusCode": 400,
  "httpMessage": "Invalid request",
  "errorMessage": "string",
  "errors": [
    {
      "severity": "ERROR",
      "message": "string",
      "diagnostic": "string",
      "source": "SYSTEM"
    }
  ],
  "supportReferenceId": "string"
}

401 Invalid or missing credentials

{
  "httpStatusCode": 401,
  "httpMessage": "Invalid or missing credentials",
  "errorMessage": "string",
  "errors": [
    {
      "severity": "ERROR",
      "message": "string",
      "diagnostic": "string",
      "source": "SYSTEM"
    }
  ],
  "supportReferenceId": "string"
}

403 User not authorized to perform this operation

{
  "httpStatusCode": 403,
  "httpMessage": "User not authorized to perform this operation",
  "errorMessage": "string",
  "errors": [
    {
      "severity": "ERROR",
      "message": "string",
      "diagnostic": "string",
      "source": "SYSTEM"
    }
  ],
  "supportReferenceId": "string"
}

404 Not Found

{
  "httpStatusCode": 404,
  "httpMessage": "Not Found",
  "errorMessage": "string",
  "errors": [
    {
      "severity": "ERROR",
      "message": "string",
      "diagnostic": "string",
      "source": "SYSTEM"
    }
  ],
  "supportReferenceId": "string"
}

The table below describes each field of the API Error Response:

Error Response Field	Description
`httpStatusCode`	The value of the HTTP status code. Possible values are: `400`, `401`, `403`, or `404`
`httpMessage`	A brief description of the HTTP status code. Possible values are: `Invalid request` (httpStatusCode = `400`), `Invalid or missing credentials` (httpStatusCode = `401`), `User not authorized to perform this operation` (httpStatusCode = `403`), or `Not Found` (httpStatusCode = `404`)
`errorMessage`	A detailed description of the error. For example: `"errorMessage": "Text '2022-03-23T18:38:00Z' could not be parsed, unparsed text found at index 19"`
`errors`	This array contains more details about the error
`errors.severity`	The severity of this message. Possible values are: `ERROR`, `WARNING`, or `INFO`
`error.message`	More information about the error.  For example: `Appointment in the Past`
`error.diagnostic`	Diagnostic information from project44 (The System) or from the Capacity Provider/Carrier. NOTE: In a Capacity Provider/Carrier integration, it would come only from project44.
`error.source`	The originator of the error message.  NOTE: In a Capacity Provider/Carrier integration, the originator will always be SYSTEM. Possible values are: `SYSTEM` (error from project44) or `CAPACITY PROVIDER` (error from the Capacity Provider or Carrier)
`supportReferenceId`	A reference identifier used by project44 support to assist with certain error messages.

Appendix

LTL Shipment Event Types

LTL Shipment State Types

LTL Shipment Stop Types

Error Response Codes

Was this helpful?