Public API - Log Shipment Changes

This article covers the functionality of Log Shipment Changes within Tai's Public API

This feature supplies EDI 204 Changes to allow Brokers to make informed decisions about 204 Updates.

When issuing a POST to /PublicApi/Shipping/v2/LogShipmentChanges, utilization of Shipment Reference Numbers will allow a match for the Shipment that needs to be compared. Reference Numbers include Shipment ID that can be used to specify as well. In the case where only a PO Number is matched the shipment will be compared.

Note: If more than one Shipment Match the Reference Numbers specified, a failure will occur. Reason is that this would need to pinpoint which shipment that would need to be properly compared with.

Shipment to Compare will house the new information so that the changes can be compared. This will contain a majority of the information within the POST /PublicApi/Shipping/v2/Shipments.

Comparisons will be added to the Activity Log as shown in the example below.

Within the API call, there's also a feature for staffAssignment. This will assign the Activity Log with the changes to the staff member specified. An additional note can be specified under activityLogMessage that can inform a Broker what next steps may be required if needed.