PackageCount Property

The number of packages returned for a given shipment id or reference number .

Syntax

 upstrack.getPackageCount([callback])

Default Value

0

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 getPackageCount([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 setPackageCount([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

When the idType is set to either 1 (Shipment Id) or 2 (Reference Number) when TrackShipment method is called, the PackageCount indicates the number of packages contained in the shipment being tracked.

When the idType is set to 0 (Package Tracking Number), then the PackageCount is set to 1 upon successful requests.

This property is read-only.

Data Type

Integer