CODReportFile Property

Filename and location to save the CODReport to.

Syntax

 upsshipintl.getCODReportFile([callback])
 upsshipintl.setCODReportFile( CODReportFile, [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 getCODReportFile([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 setCODReportFile([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 applies only to shipments within the European Union (EU) countries. When applicable and the CODReportFile is set to a valid path and filename, the contents of the CODReport are written to disk upon successful response.

This has to have .html extension.

Data Type

String