CancelShipment Method

Cancels a shipment.

Syntax

canadapostship.cancelShipment(shipmentId, [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

This method cancels a shipment. The ShipmentId parameter is the value returned by the ShipmentId property when GetPackageLabel was called.

Note: This is only valid for shipments created using a contract (e.g. when CanadaPostContractId is specified) and must be called before TransmitShipments has been called for the specified shipment;