ShipmentReference Property

Customer-defined number (that may or may not be unique) used to identify the whole shipment.

Syntax

 upstrack.getShipmentReference([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 getShipmentReference([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 setShipmentReference([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 TrackShipment method is called, and if issued at the time of shipping, this reference number (if any) will be returned in server's response.

This property is read-only.

Data Type

String