CancelPackage Method

Cancels a single package by deleting it from the shipping log.

Syntax

upsshipintl.cancelPackage(masterTrackingNumber, packageTrackingNumber, [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 shipment of a single package, a void shipment request should be sent to UPS UPSServer by calling the CancelPackage method.

For void shipment requests while your application is undergoing testing and integration, you will have to set the UPSServer to: https://wwwcie.ups.com/ups.app/xml/Void.

Once your application is in production, the UPSServer should be sent to the URL provided as part of the certification process.

The TrackingNumber parameter identifies the package to be deleted from the shipping log.

This method will return the void status of the specified package.

To check the status of your shipment void request, the ShipmentVoidStatus should be inspected.