LTL/Parcel Update
The update is sent when key tracking updates related to Parcel and LTL are made to the load.
{
"MessageType" : "PARCEL_UPDATE",
"FourKitesLoadId" : 1234,
"LoadNumber" : "BOL12345",
"ProNumber" : "PRO123",
"Shipper" : "test-shipper",
"dataSource": "fourkites-x",
"Scac" : "ABCD",
"Tags" : ["tag1", "tag2"],
"ReferenceNumbers" : ["ref1", "ref2"],
"Status" : "New Activity",
"Message" : "Load is at New York, NY",
"StopName" : "ABC Stop",
"Timestamp" : "2015-10-01T16:00:00-05:00",
"StatusCode" : "X6"
}Field Definitions
Field Name | Description | Key Always Present? | Value Always Present? | Data Type | Max Length |
|---|---|---|---|---|---|
FourKitesLoadId | Unique load identifier from FourKites system | Yes | Yes | Number | 20 |
LoadNumber | Unique shipment identifier from shipper's system | Yes | Yes | String | 65535 |
ProNumber | Shipment's PRO # | Yes | Yes | Number | 10 |
ContainerNumber | | | | String | 1024 |
dataSource | | | | String | 1024 |
Shipper | Unique shipper ID from FourKites | Yes | Yes | String | No max, but realistically, not longer than 200 characters |
Scac | SCAC of the carrier assigned to the shipment/load | Yes | Yes | Alpha/Numeric | 4 |
Tags | List of tags associated with the load (empty list when tags are not present) | Yes | Yes | Array of string | 50 for each tag |
ReferenceNumbers | List of additional reference numbers associated with the load (empty list when no reference numbers are associated with the load) | Yes | Yes | Array of string | No max |
DeviceID | | Yes | Yes | String | |
Status | Parcel/LTL status category. Example: "In Transit" or "Loaded on Truck" | Yes | Yes | String | 100 max |
Message | Indicates the tracking update details. For example, "Out For Delivery Today: MAUMEE, OH" or "Arrival Scan: MAUMEE, OH" | Yes | Yes | String | 1024 |
StopName | Name of the stop provided during load creation | Yes | Yes | String | No max |
Timestamp | Estimated Arrival Time for the stop in stop's local time (in ISO 8601 format with local time offset to UTC) | Yes | Yes | String in DateTime format | |
Carrier | | | | String | 1024 |
StopStatusCode | EDI Code associated with the status update. Example X3 would be sent for the status "At Pickup". | Yes | Yes | String | 50 at max |