FourKites X Info Update Callback

2 min

It is triggered whenever any of the FKX-specific data is updated to a load.

This is not applicable for the Carrier Service Level.

{
"CarrierCommitDate": "2023-06-04T12:00:00Z",
    "CarrierId": "fedexparcl",
    "CarrierServiceType": "FedEx Home Delivery",
    "FourKitesLoadId": 9720297,
    "LoadNumber": "callback-5",
    "MessageType": "FOURKITES_X_INFO_UPDATE",
    "OrderInformation": null,
    "PackageDetails": {
        "DimensionsUnit": "IN",
        "Height": 4.8,
        "Length": 12,
        "PackageType": null,
        "TotalPieces": 1,
        "Weight": 1.2,
        "WeightUnit": "LB",
        "Width": 9.4
    },
    "PaymentDetails": [
        {
            "PaymentParty": "shipper",
            "PayorAccountNumber": "482755828"
        }
    ],
    "RecipientAccountNumber": null,
    "ShipperAccountNumber": "482755828",
    "ShipperId": "shippername",
    "SignatureName": null,
    "TrackingNumber": null
}

Field Definitions

Field Name	Description	Key Always Present?	Value Always Present?	Conditions for the Key to be Present	Data Type	Max Length
LoadNumber	Unique shipment identifier from shipper's system	Yes	Yes	N/A	String	65535
FourKitesLoadId	Unique load identifier from FourKites system if the load was successfully created (IsSuccess = true). The field will be null if the load creation failed in FourKites	Yes	Yes	N/A	Number	20
CarrierCommitDate	Date committed by the Carrier before which they will have the package delivered	No	No	The key will be present if the value is updated or created.	String	30
CarrierServiceType	This field captures the service level of the Shipment. 2-day Delivery, 3-day Delivery, Express etc	No	No	The key will be present if the value is updated or created.	String	255
ShipperId	Shipper Identifier in FourKites system	Yes	Yes	N/A	String	255
CarrierId	Carrier Identifier in FourKites system	Yes	Yes	N/A	String	1024
TrackingNumber	Unique Tracking Number of the Carrier	Yes	Yes	N/A	String	1024
SignatureName	Signer's name who has signed for the package upon delivery	No	No	The key will be present if the value is updated or created.	String	255
ShipperAccountNumber	Account Numberof the Shipper associated with the shipment	Yes	Yes	N/A	String	255
RecipientAccountNumber	Account Number of the recipient associated with the shipment	Yes	Yes	N/A	String	255
OrderInformation	Order Number related to the shipment	Yes	Yes	N/A	Json Object
PackageDetails	Type of Package used by the shipment - Package	Yes	Yes	N/A	Json Object
PaymentDetails	The payment party associated with the shipment: Shipper, Recipient or Third party	Yes	Yes	N/A	Array