TotalSurcharges Property

The total surcharges (on all options) applied to the whole shipment (specific to the AccountNumber ).

Syntax

 upsshipintl.getTotalSurcharges([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 getTotalSurcharges([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 setTotalSurcharges([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

In a MPS ship request, this represents the total surcharges applied to all packages contained in the shipment. When the shipment consists of a single package, this is the same as PackageTotalSurcharges at index=0.

This property is read-only.

Data Type

String