ReasonForExport Property

The reason for the export.

Syntax

 canadapostshipintl.getReasonForExport([callback])
 canadapostshipintl.setReasonForExport( reasonForExport, [callback])

Possible Values

  0 (erGift), 
  1 (erDocument), 
  2 (erCommercialSample), 
  3 (erRepair), 
  4 (erSale), 
  5 (erOther)

Default Value

0

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 getReasonForExport([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 setReasonForExport([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

This provides the reason for the export, which is necessary to generate the customs forms.

The valid values are as follows:

Data Type

Integer