TotalValue Property

Monetary value of shipment contents.

Syntax

 upsrates.getTotalValue([callback])
 upsrates.setTotalValue( totalValue, [callback])

Default Value

"0.00"

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

Required for all non-document shipments outside the US. Required for Document shipments (when Documents is set to True) only when either the SenderCountryCode or RecipientCountryCode is CA (Canada).

This is returned in the server response only if provided in the request.

Cannot exceed more than 9 whole numbers and 2 decimal places. Maximum value is: 999999999.99.

Data Type

String