TotalWeight Property
The estimated weight for the package to be picked up.
Syntax
uspsship.getTotalWeight([callback]) uspsship.setTotalWeight( totalWeight, [callback])
Default Value
0
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
Enter the total estimated aggregate weight (in pounds) of all packages being picked up.
This property is required when the following methods are called:
and retrieved in the:- PickupInquiry method call.
Data Type
Integer