TotalWeight Property
Shipment's total weight.
Syntax
upstrack.getTotalWeight([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 getTotalWeight([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 setTotalWeight([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 is returned by UPS Server only if the shipment being tracked is a multi-piece shipment (PackageCount > 1) and not a single piece.
TotalWeight is set to 0 for shipment with packages of package type of letters.
This property is read-only.
Data Type
String