Order Risk

2 min

When a risk is identified as either a manual risk or an automated risk, it is sent via callbacks at an order level to the customer.

{
    "MessageType": "RISK_REASON_REVOKED"/"RISK_REASON_ADDED",
    "companyId": "po-automation-shipper",
    "loadId": unique number based on orderId, 
    "createdAt": <timestamp>,
    "uuid": "unique id",
    "payload":{
        "orderNumber": 123,
        "orderMetaData":{
            "orderStatus": "delivered",
            "orderType": "PO",
            "orderPaymentType": "prepaid",
            "orderTransportType": "domestic",
            "orderActualShipDate": <timestamp>,
            "orderDestinationETA": <timestamp>,
            "orderPickupETA": <timestamp>,
            "orderActualDeliveryDate": <timestamp>,
            "deliveryIds": ["123", "456"],
            "shipmentIds": ["123", "456"]   
        },
        "callBackRiskReasons":{
                "eventTime": <time>
                "riskCode": <string>
                "risk": <string>
                "riskReason": <string>
                "riskSource": <string>
                "riskPriority": <string>
                "reasonRemovedBy": <string>
                "reasonAddedBy": <string>
        }
    }
}

Field Definitions

Field Name	Description	key Always Present?	Value Always Present?	Data Type	Max Length
eventType	The type of event or message (eg, RISK_REASON_ADDED or RISK_REASON_REVOKED)	Yes	Yes	String	No Max
companyId	The unique identifier for the company in the FourKites system	Yes	Yes	String	No Max
loadId	A unique number based on orderId	Yes	Yes	long	9,223,372,036,854,770,000
createdAt	The timestamp when the callback was generated	Yes	Yes	TimeStamp	No Max
uuid	Unique Id for callback	Yes	Yes	String	No Max
payload				String	No Max
orderNumber	The unique identifier for the order	Yes	Yes	String	No Max
orderMetaData				json	No Max
orderStatus	The current status of the order (e.g., open_updated, fully_delivered)	Yes	Yes	String	No Max
orderType	The type of order (e.g., PO for Purchase Order).	Yes	Yes	String	No Max
orderPaymentType	The method of payment for the order.	Yes	No	String	No Max
orderTransportType	The type of transport used for the order (e.g., domestic).	Yes	No	String	No Max
orderActualShipDate	The actual ship date of the order, if available	Yes	No	String	No Max
orderDestinationETA	The estimated time of arrival at the order's destination.	Yes	No	TimeStamp	No Max
orderPickupETA	The estimated time of arrival at the order's pickup.	Yes	No	TimeStamp	No Max
orderActualDeliveryDate	The actual delivery date of the order, if available	Yes	No	TimeStamp	No Max
deliveryIds	The unique identifier for the delivery.	Yes	No	TimeStamp	No Max
shipmentIds	The unique identifier for the shipment.	Yes	No	Array	No Max
callBackRiskReasons			No	Array	No Max
eventTime	The timestamp when the event occurred	Yes	Yes	TimeStamp	No Max
riskCode	The risk code associated to an Order	Yes	Yes	String	No Max
risk	The Risks associated to an Order (eg Delivery at Risk)	Yes	Yes	String	No Max
riskReason	The Risk reasons associated to an Order	Yes	Yes	String	No Max
riskSource	The source of the risk (eg Shipment)	Yes	Yes	String	No Max
riskPriority	Priority of the risk (eg High)	Yes	Yes	String	No Max
reasonRemovedBy	Risk reason removed by source	Yes	No	String	No Max
reasonAddedBy	Risk reason added by source	Yes	No	String	No Max