TotalCustomsValue Property

Total customs value for the shipment.

Syntax

 upsshipintl.getTotalCustomsValue([callback])
 upsshipintl.setTotalCustomsValue( totalCustomsValue, [callback])

Default Value

"1"

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 only if the following requirements are met:

• the SenderCountryCode is US;
• the RecipientCountryCode is either CA (Canada) or PR (PuertoRico);
• the shipment does not contain any package of UPS Letter type;

If Commercial Invoice is requested (i.e., one of the FormTypes is set to Invoice), this value should match the invoice line total on the invoice form. If not it will be replaced by the actual calculated invoice line total. It represents the sum of the values of all commodities included in the shipment.

Format: Whole number, no decimal position (e.g. 100) with maximum length of 8 digits. Possible values: 1 to 99999999.

Data Type

String