TotalWeight Property
Total shipment's weight.
Syntax
ezrates.getTotalWeight([callback]) ezrates.setTotalWeight( totalWeight, [callback])
Default Value
"1.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
This indicates shipment's weight.
Allows for only one decimal point and one decimal place.
For FedEx, this property is required unless there is only one package in the shipment and that package's weight is provided in the PackageWeight property.
For UPS, this is required for shipments outside the US and non-document shipments inside the US. It will be returned in the server response only if provided in the request.
This property is not applicable to USPS shipments.
Data Type
String