User Message
This callback will be sent as soon as a user message functionality within the FourKites application has been leveraged.
Request Parameter
{
"FourKitesLoadId": 353428966,
"IsDriver": false,
"LoadNumber": "0083890939",
"MessageType": "USER_NOTE",
"Note": "Container has been In-gate on 09/28.",
"ProNumber": "0083891178",
"ReferenceNumbers": [
"0091761270",
"0004737544",
"0083891178",
"0083890939",
"NAM6476499",
"EXFU0595594"
],
"Scac": "CMDU",
"Shipper": "eastman-chemical-north-america",
"Tags": [
"EXFU0595594",
"U144454-Yong Jae Paek",
"1A02 - Origin",
"PETALING JAYA - Dest",
"SAINT GABRIEL - Origin",
"H3565491 - MATRIX OLEOCHEM",
"4324425 - MATRIX OLEOCHEM SDN BHD",
"Loaded",
"90708ADD & FNCT PROD",
"0065CARE CHEMICALS",
"9249PERSONAL CARE",
"U212633-Stella Shi",
"CCTC"
],
"Timestamp": "2023-10-11T07:31:54+00:00",
"UserId": "angali-manoj"
}Field Definitions
Field Name | Description | Key Always Present? | Value Always Present? | Conditions for the Key to be Present | Data Type | Max Length |
|---|---|---|---|---|---|---|
LoadNumber | It is the unique load identifier from shipper's system. | Yes | No | N/A | String | 65535 |
Shipper | Unique permalink for the company. This is generated by FourKites and is unique for each company | Yes | No | N/A | String | No max, but realistically, not longer than 200 characters |
Timestamp | Time that the load was created | Yes | No | Timestamp will be converted to UTC before getting mapped | String in DateTime format | 30 |
FourKitesLoadId | Will always be present unless there were issues creating the load. If the load was not created, the IsSuccess flag will be false and no FourKitesLoadId will be generated | Yes | No | TrackingId will be mapped to FourKitesLoadId | Number | 20 |
LoadNumber | Customer supplied Load Number. This is populated on the Create Load API | Yes | Yes | N/A | String | 65535 |
ProNumber | PRO Number associated with the load | Yes | No | N/A | Number | 10 |
Shipper | Unique permalink for the company. This is generated by FourKites and is unique for each company | Yes | Yes | N/A | String | No max, but realistically, not longer than 200 characters |
Scac | SCAC or identifier for the carrier | Yes | No | N/A | Alpha/Numeric | 4 |
ReferenceNumbers | List of unique identifiers for the load. These can be used to search for the load the platform | Yes | No | N/A | Array of string | No max |
UserId | | Yes | Yes | N/A | | |
Note | Message added to the load. | Yes | Yes | N/A | String | 3020 |
IsDriver | Indicates if the message is added by a driver via CarrierLink. | Yes | No | N/A | Boolean | true/false |