Delivery Updated: Success Response

4 min

This callback will be triggered when your delivery is successfully updated on the FourKites platform.

This sample payload is for delivery update success case and the isSuccess field will be true.

Request Parameter

{
  "CompanyPermalink": "po-XXXX-shipper",
  "DeliveryIdentifier": "DEL-BTX58720193-02",
  "DeliveryStatus": open,
  "DeliveryType": xyz,
  "FailureCode": null,
  "FailureDetails": null,
  "FailureReason": null,
  "FailureTime": null,
  "MessageType": "DELIVERY_UPDATED",
  "createdAt": "2025-07-14T06:21:18.104223534Z[GMT]",
  "isSuccess": true,
  "updatedAt": "2025-07-14T06:21:18.109435638Z[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
DeliveryIdentifier	The unique identifier for the delivery in the FourKites system. Used to track and reference the specific delivery instance.	Yes	Yes	string	no max
DeliveryStatus	The current status of the delivery (e.g., "open", "in_transit", "delivered", "completed"). Indicates the current stage in the delivery lifecycle.	Yes	Yes	string	no max
DeliveryType	The classification or type of delivery service being performed (e.g., "standard", "express", "same_day", "freight").	Yes	Yes	string	no max
FailureCode	The specific error code associated with delivery creation failure. Will be null in success cases.	Yes	No	string	no max
FailureDetails	Detailed technical information about the delivery creation failure. Will be null in success cases.	Yes	No	string	no max
FailureReason	A high-level categorization of the failure reason. Will be null in success cases.	Yes	Yes	string	no max
FailureTime	The exact timestamp when the delivery creation failure occurred. Will be null in success cases.	Yes	No	string	34
MessageType	The type of event or message being sent. For delivery creation events, this will be "DELIVERY_CREATED".	Yes	Yes	string	Realistically no longer than 50
createdAt	The timestamp when the delivery creation event was created in the FourKites system in ISO 8601 format with GMT timezone.	Yes	Yes	string	34
isSuccess	Boolean flag indicating whether the delivery creation was successful (true) or failed (false). Will be true for all successful delivery creation events.	Yes	Yes	Boolean	N/A
updatedAt	The timestamp when the delivery or event was last updated in the FourKites system in ISO 8601 format with GMT timezone.	Yes	Yes	string	34

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