CancelShipment Method
Cancels an entire multi-package (MPS) shipment by deleting it from the shipping log.
Syntax
upsship.cancelShipment(masterTrackingNumber, [callback])
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for this method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
To cancel an entire MPS shipment, a void shipment request should be sent to UPS Server by calling the CancelShipment method.
For void shipment requests while your application is undergoing testing and integration, you will have to set the Server to: https://wwwcie.ups.com/ups.app/xml/Void.
Once your application is in production, the Server should be sent to the URL provided as part of the certification process.
The MasterTrackingNumber parameter identifies the shipment that contains all packages to be deleted from shipping log.
To check the status of your shipment void request, the ShipmentVoidStatus should be inspected.