MasterTrackingNumber Property

Tracking number assigned to the whole MPS shipment.

Syntax

 upsshipintl.getMasterTrackingNumber([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 getMasterTrackingNumber([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 setMasterTrackingNumber([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 is applicable to MPS shipment requests only and identifies the whole shipment. In a MPS ship request, this property is returned in the server reply when the GetShipmentLabels method is called.

This value is used as parameter when a cancel shipment request is sent (i.e., when the CancelShipment method is called). It can also be used when tracking a MPS.

This property is read-only.

Data Type

String