InsurancePolicy Property

Insurance number, if known.

Syntax

 uspsshipintl.getInsurancePolicy([callback])
 uspsshipintl.setInsurancePolicy( insurancePolicy, [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 getInsurancePolicy([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 setInsurancePolicy([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

If insurance has been purchased, this property should be set to the policy number.

This property is not applicable for International First Class mail.

Data Type

String