Rail status event update
4 min
Rail Event
POST
https://api.fourkites.com/load/update/dispatcher-api/async
curl --location 'https://api.fourkites.com/load/update/dispatcher-api/async' \
--header 'Content-Type: application/json' \
--header 'apikey: testkey' \
--data '{
"updates": [
{
"timeZone": "UTC",
"billToCode": "Shipper unique id",
"identifierKeys": [
{
"identifier": "Load reference #1",
"rawIdentifier": "Carrier format - Load reference #1",
"identifierType": "Load reference identifier type in FourKites or Carrier company" //If FourKites standard used, then only reference would be searched using given identifierType otherwise skipped
},
{
"identifier": "Load reference #2",
"rawIdentifier": "Carrier format - Load reference #2",
"identifierType": "Load reference identifier type in FourKites or Carrier company"
},
{
"identifier": "Load reference #3",
"rawIdentifier": "Carrier format - Load reference #3",
"identifierType": "Load reference identifier type in FourKites or Carrier company"
},
{
"identifier": "Load reference #4",
"rawIdentifier": "Carrier format - Load reference #4",
"identifierType": "Load reference identifier type in FourKites or Carrier company"
}
],
"assignmentUpdate": {
"railEquipmentInitials": "railEquipmentInitials",
"railEquipmentNumber": "railEquipmentNumber",
"wagonNumber": "wagonNumber"
},
"loadUpdate": [
{
"eventUpdate": {
"modeType": [
"rail"
],
"statusCode": "statusCodeevent",
"statusDescription": "statusDescriptionevent",
"statusReasonCode": "statusReasonCodeevent",
"eventTimeStamp": "eventTimeStampevent",
"city": "cityevent",
"state": "stateevent",
"country": "country",
"railEventCode": "railEventCode",
"shipmentStatusIndicator": "shipmentStatusIndicator",
"shipmentStatus": "shipmentStatus"
}
}
]
}
]
}'At least one of the fields — railEventCode, shipmentStatusIndicator, or shipmentStatus — is required to be mapped to Rail Event.
Header
Content-Type | application/json |
|---|---|
apikey | testkey |
Body
{
"updates": [
{
"timeZone": "UTC",
"billToCode": "Shipper unique id",
"identifierKeys": [
{
"identifier": "Load reference #1",
"rawIdentifier": "Carrier format - Load reference #1",
"identifierType": "Load reference identifier type in FourKites or Carrier company" //If FourKites standard used, then only reference would be searched using given identifierType otherwise skipped
},
{
"identifier": "Load reference #2",
"rawIdentifier": "Carrier format - Load reference #2",
"identifierType": "Load reference identifier type in FourKites or Carrier company"
},
{
"identifier": "Load reference #3",
"rawIdentifier": "Carrier format - Load reference #3",
"identifierType": "Load reference identifier type in FourKites or Carrier company"
},
{
"identifier": "Load reference #4",
"rawIdentifier": "Carrier format - Load reference #4",
"identifierType": "Load reference identifier type in FourKites or Carrier company"
}
],
"assignmentUpdate": {
"railEquipmentInitials": "railEquipmentInitials",
"railEquipmentNumber": "railEquipmentNumber",
"wagonNumber": "wagonNumber"
},
"loadUpdate": [
{
"eventUpdate": {
"modeType": [
"rail"
],
"statusCode": "statusCodeevent",
"statusDescription": "statusDescriptionevent",
"statusReasonCode": "statusReasonCodeevent",
"eventTimeStamp": "eventTimeStampevent",
"city": "cityevent",
"state": "stateevent",
"country": "country",
"railEventCode": "railEventCode",
"shipmentStatusIndicator": "shipmentStatusIndicator",
"shipmentStatus": "shipmentStatus"
}
}
]
}
]
}