PackageReferences Property

References (other than tracking number) assigned to the package at PackageIndex by either shipper or customer.

Syntax

 eztrack.getPackageReferences([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 getPackageReferences([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 setPackageReferences([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 should be inspected after a call to the TrackShipment method.

For FedEx, when populated, it is a string in this format: "Reference Type: Reference Value" pairs (separated by ';' if more than one reference is found).

For UPS, when populated, it is a csv string. A package can have 0 to many reference numbers assigned to it by the shipper when the shipping label was generated.

Currently, USPS does not support multiple package shipments and this does not apply.

This property is read-only.

Data Type

String