Shipping Integrator V5 - Online Help
Shipping Integrator V5
Questions / Feedback?

PackageIndex Property

The package index in a shipment returned for a given shipment id or reference number .

Syntax

 upstrack.getPackageIndex([callback])
 upstrack.setPackageIndex( packageIndex, [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 getPackageIndex([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 setPackageIndex([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 contains the index of a package returned from the UPS Server after calling TrackShipment method where the idType is set to either 1 (Shipment Id) or 2 (Reference Number).

The PackageCount will contain the number of packages included in a shipment and the PackageIndex will contain the package index in the list of packages.

To retrieve all attributes corresponding to a package, the PackageIndex should be set from 0 to PackageCount - 1.

Data Type

Integer

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0