PackageMessage Property

Message describing the shipping status in more details corresponding to the PackageIndex .

Syntax

 upstrack.getPackageMessage([callback])

Default Value

""

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 the getPackageMessage([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setPackageMessage([callback]) 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 property may be returned in server response when the TrackShipment method is called. If the shipment contains multiple packages, the PackageMessage corresponds to each package being shipped as part of this shipment.

To retrieve this property corresponding to each package, the PackageIndex should be set from 0 to PackageCount - 1.

This property is read-only.

Data Type

String