Appendix
Truckload Event Types
Event Type | Description |
---|---|
ARRIVED | Send when the vehicle arrives at any stop. |
LOADING | Send when the shipment is being loaded onto the vehicle. |
DEPARTED | Send when the vehicle departs any stop. |
SCANNED_AT_STOP | Send if the load has been scanned at any stop. |
UNLOADING | Send when the vehicle is being unloaded. |
DELIVERED | Send when the vehicle has been completely unloaded. project44 uses the receipt of this value to mark this shipment delivered for the customer. |
CANCELLED | Send if the shipment is cancelled. |
POSITION | Send a position update. |
GATE_IN | Send when the shipment has arrived at a terminal. |
GATE_OUT | Send when the shipment has departed a terminal and resumed transit. |
ARRIVED_AT_TERMINAL | Send when the shipment has arrived at the carrier’s terminal and it will be traveling on a mode other than Truckload. |
DEPARTED_TERMINAL | Send when the shipment has departed the intermodal terminal and is back on Truckload. |
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": "string", "errorMessage": "string", "errors": [ { "severity": "ERROR", "message": "string", "diagnostic": "string", "source": "SYSTEM" } ], "supportReferenceId": "string" }
401 Invalid or missing credentials
{ "httpStatusCode": 401, "httpMessage": "string", "errorMessage": "string", "errors": [ { "severity": "ERROR", "message": "string", "diagnostic": "string", "source": "SYSTEM" } ], "supportReferenceId": "string" }
403 User not authorized to perform this operation
{ "httpStatusCode": 403, "httpMessage": "string", "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 , or403 |
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) |
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 , 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 (project44 error) or CAPACITY PROVIDER (Capacity Provider or Carrier error). |
supportReferenceId | A reference identifier used by project44 support to assist with certain error messages. |