PackageWeight Property

Package's weight corresponding to the PackageIndex .

Syntax

 upstrack.getPackageWeight([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 getPackageWeight([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 setPackageWeight([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 is returned by UPS Server when the TrackShipment method is called. If the shipment contains only one package (PackageCount=1), this is the same as PackageWeight. This is set to 0 for package type of letters.

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