TotalValue Property

Total value of the items inside the package.

Syntax

 uspsrates.getTotalValue([callback])
 uspsrates.setTotalValue( totalValue, [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 getTotalValue([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 setTotalValue([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 used by USPS to compute the InsuranceCost and IndemnityCoverage. (if they are available for the current RequestedService and RecipientCountryCode).

Data Type

String