JSON Response Structure and Format

The Update Status Response confirms the shipment has been updated or returns an error.

The update status response JSON message is comprised of the following sections.

1. Status Update Response section:

The status update response element returns the message details on whether the status update was successful or not. If the status of one or more shipments in the status update request fails, then that shipment will return an error response, but the shipments that were successfully updated will return a success message.

The fields, data types and conditions that will be validated in this section as detailed below.

2. Errors responses:

The system may respond with error information, to tell the receiving system that the original request to update status for a shipment was not successfully processed due to errors.

🚧

The errors message will only ever be returned if errors have been encountered, if there are no errors, then this response will not be generated.

The fields, data types and conditions that will be validated for in the errors section as detailed below.