JSON Request Structure and Format

The Update Status Shipment request JSON message is comprised of the following sections.

For further details on the standard JSON message formatting, please refer to the Shipping API JSON Formatting Rules

To successfully process an Update Status request, the user must have a valid connection, that has been verified by use of a system generated Authentication Token. For further details on system authentication, please refer to the Authentication guide.

1. Status Update:

The status update element details the status that the shipment is required to be update to as well as the reason for the status update.

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

2. Shipment IDs sub-section:

This sub-section is embedded within the Status Update section and is used to define the shipments that will have their statuses updated. It is possible to update up to 99 shipments at one time.

The fields, data types and conditions that will be validated for in the Service options sub-section as detailed below.

Example Request JSON:

Below is an Update Status Request JSON example, this has been placed into a table, to better separate and distinguish the different sections detailed above.