Cancels an entire multi-package shipment, as specified by the master tracking number. This procedure also has the side effect of deleting the corresponding records from the LabelHistory table.
Procedure Specific Information
The stored procedure will remove records from the following table:
In order to execute this procedure, one must specify MasterTrackingNumber. See the example below:
EXECUTE CancelShipment MasterTrackingNumber = '1Z12345E0390105056'
|MasterTrackingNumber||String||Master tracking number of packages to be canceled.|
|TrackingIdType||String|| Type of identifier used to track shipment.
The allowed values are Express, Ground.
The default value is Express.
|ShipDate||Date||Date the shipment was to be shipped. This value should be in the format (yyyy-MM-dd).|
|ShipTime||Time||Time the shipment was to be shipped. This value should be in the format (hh:mm:ss).|
Result Set Columns
|Success||String||Success or failure.|