MasterTrackingNumber Property

UPS-assigned tracking number assigned to the whole shipment .

Syntax

 upstrack.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

If the shipment contains only one package (PackageCount = 1), the MasterTrackingNumber is the same as the first PackageTrackingNumber (where PackageIndex = 1). This property is returned in the server response for track requests other than tracking by Reference Number (i.e., IdentifierType is set to a value other than itReferenceNumber).

The MasterTrackingNumber uniquely identifies a shipment up to 18 months. However, it is possible that this number may be reused within a shorter time period. If this occurs, a query by Master Tracking Number returns all shipments (from the same ShipperAccountNumber) matching this number.

This is not available for freight shipments.

This property is read-only.

Data Type

String