Load Updation
You now have the option to receive a notification to your callback URL when specific parameters of an existing load are updated. This keeps you informed of the updates (if any) that are made to your existing loads. This article details the parameters that trigger the notification when updated, along with a sample notification and a description of the different fields in the notification.
The parameters of a load that triggers this notification when updated are listed below:
- Priority
- ProNumber
- CustomerId
- Carrier
- Scac
- Tags
- ReferenceNumbers
- TrackingNumber
{
"Shipper": "test-shipper",
"CarrierServiceType": "name_service",
"LoadNumber":"BOL12345",
"deliveryNumbers": ["DN001", "DN002"],
"masterTrackingNumber": "MTN12345",
"ProNumber": 1234,
"BillofLading": "bill_of_lading",
"BookingNumber": "booking_number",
"dataSource": "fourkites-x",
"VesselName": "DDC CMD 256AC",
"ContainerType": "40FT",
"ContainerNumber":"BEAU5912889",
"VoyageNumber": "108EE",
"Timestamp": "2018-11-14T11:11:57Z",
"Scac": "ABCD",
"Tags": ["tag1", "tag2"],
"MessageType": "LOAD_UPDATE",
"EncryptedAccessToken": "VjJ8Z3NzaGlwcGVyfDYxNmJiYjYzLTgxYzxxxxxxxxxxYzgyLTE2ZWI3YWJhMzhjZQ",
"EncryptedUrl": "https://app.fourkites.com/#/integrations/trackLoad/VjJ8Z3NzaGlwcGVyfDYxNmJiYjYzLTgxYzxxxxxxxxxxYzgyLTE2ZWI3YWJhMzhjZQ"
"UpdatedFields": ["Priority, "StopType", "CarrierServiceType"],
"IsSuccess": true,
"TimezoneShortName": "UTC",
"FourKitesLoadId": 348755,
"Timezone": "Etc/UTC",
"ReferenceNumbers" : ["ref1", "ref2"],
"TimezoneOffset": 0
}Field Definitions
Field Name | Description | Key Always Present? | Value Always Present? | Conditions for the Key to be Present | Data Type | Max Length |
|---|---|---|---|---|---|---|
FourKitesLoadId | Unique load identifier from FourKites system if the load was successfully updated (IsSuccess = true). The field will be null if the load updation failed in FourKites | Yes | Yes | Tracking ID will be mapped to FourKitesLoadId | Number | 20 |
LoadNumber | Unique shipment identifier from shipper's system | Yes | Yes | N/A | String | 65535 |
deliveryNumbers | It indicates that the load has delivery number values | No | No | If the values are available | String | No Limit |
masterTrackingNumber | It indicates that the load has master tracking number value | No | No | If the value is available | String | No Limit |
CarrierServiceType | The field helps logistics systems track and manage different service levels across shipments, allowing for proper routing, pricing, and delivery expectation management. | No | No | This key is currently received for a portion of LTL/Parcel loads. | String | No max, but realistically, not longer than 200 characters |
ProNumber | Shipment's PRO # | Yes | No | N/A | Number | 10 |
Shipper | Unique shipper ID from FourKites | Yes | Yes | N/A | String | No max, but realistically, not longer than 200 characters |
Tags | Array of tags associated with the load (empty list when tags are not present) | Yes | Yes | N/A | Array of string | 50 for each tag |
EncryptedAccessToken | The access token that would be used to create an encrypted URL | Yes | Yes | This field is a feature flag. If you're interested you can subscribe to this field. | String | 2048 |
EncryptedUrl | Encrypted URL of the load which is unique and which can be used to access details of the load | Yes | No | This is a feature flag. | String | 1024 |
ReferenceNumbers | Array of additional reference numbers associated with the load (empty list when no reference numbers are associated with the load) | Yes | Yes | N/A | Array | no max |
Timestamp | Timestamp associated with the location in the message (in ISO 8601 format in UTC) | Yes | Yes | Timestamp will be converted to UTC. | String in DateTime format | |
Timezone | Will be hard coded to "Etc/UTC" to indicate timestamp is in UTC | Yes | Yes | N/A | String | |
TimezoneShortName | Will be hard coded to "UTC" | Yes | Yes | N/A | String | |
TimezoneOffset | Will be hard coded to 0 | Yes | Yes | N/A | Number | 10 |
Errors | Array of errors if load updation failed (IsSuccess = false) | Yes | No | N/A | Array | No max limit |
BillofLading | It indicates the bill of lading associated with the load. | Yes | Yes | For Ocean Loads. | String | 1024 |
BookingNumber | It indicates the shipping line's booking number. | Yes | Yes | For Ocean Loads. | String | 1024 |
VesselName | It indicates the name of the vessel carrying the load. | Yes | Yes | For Ocean Loads. | String | 1024 |
ContainerType | It indicates whether the container is a general, high cube, Reefer, etc., type of container. | Yes | Yes | For Ocean Loads. | String | 1024 |
ContainerNumber | Container Number of the ocean load | Yes | Yes | For Ocean Loads. | String | 1024 |
VoyageNumber | It indicates the unique identifier given for the voyage. | Yes | Yes | For Ocean Loads. | | |
IsSuccess | Indicates whether the load was successfully updated or not | Yes | Yes | N/A | Boolean | True/False |
CreatedBy | This applies only for FourKites X loads. | Yes, if it's a FourKites X load. | Yes, if it's a FourKites X load. | The CreatedBy field will be available and sent only for FourKites X licensed customers — this is to identify between FourKites X and non FourKites X loads. | String | 1024 |
Points to Note:
Note: The EncryptedAccessToken field will not be available by default. Get in touch with your Customer Success Manager at FourKites to enable it for your company.
Load Update callback will also be triggered if and when the following list of errors occur during the updation of load:
- Stops status is not included in the list
- Stops should contain at least one pickup and one delivery OR one transfer and one delivery location
- Stops should contain port of loading and port of discharge
- Load mode is not included in the list
- Driver phone is invalid
- Priority is not included in the list
- Rail equipment initials is too long (maximum is 4 characters)
- Rail equipment number is too long (maximum is 6 characters)
- Valid_delivery_timestamp