TotalCustomsValue Property

Total customs value for the shipment.

Syntax

 fedexfreightship.getTotalCustomsValue([callback])
 fedexfreightship.setTotalCustomsValue( totalCustomsValue, [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 getTotalCustomsValue([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 setTotalCustomsValue([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

The TotalCustomsValue is required to be provided in an international shipment request. It represents the sum of the values of all commodities, and may include freight, miscellaneous, and insurance charges.

Format: Two explicit decimal positions (e.g. 100.00) with a maximum length of 17 including the decimal.

The following countries require a minimum customs value of $1 USD for all shipment, including document shipments:

Note this only applies when shipping internationally.

Data Type

String