Order Updated: Failure Response

4 min

This callback will be triggered when your order update fails on the FourKites platform.

This sample payload is for order update failure case and the isSuccess field will be false. The failure-related fields (FailureCode, FailureDetails, FailureReason, FailureTime) will contain relevant error information to help diagnose the issue.

Request Parameter

{
  "CompanyPermalink": "po-XXXX-shipper",
  "FailureCode": "1002",
  "FailureDetails": "Sending simpleUpdate as False, but no existing order was found in the system with OrderNumber. Order-Jul-11-11",
  "FailureReason": "Invalid request",
  "FailureTime": "2025-07-11T07:00:30.494337902Z[GMT]",
  "FourKitesOrderId": null,
  "MessageType": "ORDER_UPDATED",
  "OrderActualDeliveryDate": "null",
  "OrderActualShipDate": "null",
  "OrderDestination": null,
  "OrderDestinationETA": "null",
  "OrderETA": "null",
  "OrderETAStatus": null,
  "OrderEURL": "https://app-staging.fourkites.com/inventory/orders/eurl/49EKT1mm4BuqvtX0t0Rh8iHbkE3j9UqcW1bidbdv5XlcZFQ%2BUjgZg/SxwqRXpQCC",
  "OrderMustShipByDate": "null",
  "OrderNumber": "Order-Jul-11-11",
  "OrderPaymentType": null,
  "OrderPickupETA": "null",
  "OrderReferenceNumbers": [],
  "OrderRequiredDeliveryDate": "null",
  "OrderStatus": null,
  "OrderStatusTime": "null",
  "OrderType": null,
  "createdAt": "2025-07-11T07:00:30.494757913Z[GMT]",
  "isSuccess": false,
  "orderTransportType": null,
  "updatedAt": "2025-07-11T07:00:30.494767132Z[GMT]"
}

Field Definitions

Field Name	Description	Key Always Present?	Value Always Present?	Data Type	Max Length
CompanyPermalink	The unique identifier for the company in the FourKites system.	Yes	No	string	no max
FailureCode	The error code associated with order creation failure. Only populated when isSuccess is false.	Yes	No	string
FailureDetails	Detailed information about the order creation failure. Only populated when isSuccess is false.	Yes	No	string
FailureReason	The reason for order creation failure. Only populated when isSuccess is false.	Yes	No	string
FailureTime	The timestamp when the order creation failure occurred. Only populated when isSuccess is false.	Yes	No	string	34
FourKitesOrderId	The unique identifier for the order in the FourKites system.	Yes	No	UUID	36
MessageType	The type of event or message (e.g., ORDER_CREATED, GATE_OUT, SHIPMENT_PICKED_UP).	Yes	Yes	string	Realistically no longer than 50
OrderActualDeliveryDate	The actual delivery date of the order, if available.	Yes	No	string	34
OrderActualShipDate	The actual ship date of the order, if available.	Yes	No	string	34
OrderDestination	The final destination of the order.	Yes	No	string	no max
OrderDestinationETA	The estimated time of arrival at the order's destination.	Yes	No	string	34
OrderETA	The estimated time of arrival of the order.	Yes	No	string	34
OrderETAStatus	The status of the estimated time of arrival (e.g., on-time, late).	Yes	No	string	9
OrderEURL	The URL link to view the order details in the FourKites application.	Yes	No	string	no max
OrderMustShipByDate	The date by which the order must be shipped.	Yes	No	string	34
OrderNumber	The unique identifier for the order.	Yes	Yes	string	no max
OrderPaymentType	The method of payment for the order.	Yes	No	string	no max
OrderPickupETA	The estimated time of arrival for the order pickup.	Yes	No	string	34
OrderReferenceNumbers	A list of reference numbers associated with the order.	Yes	No	Array of String	no max
OrderRequiredDeliveryDate	The required delivery date for the order.	Yes	No	string	34
OrderStatus	The current status of the order (e.g., open_updated, fully_delivered).	Yes	No	string	no max
OrderStatusTime	The timestamp of the current status of the order.	Yes	No	string	34
OrderType	The type of order (e.g., PO for Purchase Order).	Yes	No	string	3
isSuccess	Boolean flag indicating whether the order creation was successful (true) or failed (false).	Yes	Yes	Boolean	N/A
createdAt	The timestamp when the event was created.	Yes	Yes	string	34
orderTransportType	The type of transport used for the order (e.g., domestic).	Yes	No	string	13

Failure Codes & Reasons

Failure Code	Failure Reason
9999	"Unknown error"
1000	"No order found"
1005	"Duplicate Data - Payload already exists"
8888	"Access Denied"
1001	"Message not readable - Cannot parse the message"
1003	"Method not supported"
1004	"Type mismatch"
1002	"Invalid date-time format" - If message contains "invalid date-time" or "zoneddatetime"
1002	"Invalid request" - Default case when no other pattern matches