CloseReportFile Property

File name of the report to be saved and/or printed by customer.

Syntax

 fedexshipintl.getCloseReportFile([callback])
 fedexshipintl.setCloseReportFile( closeReportFile, [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 getCloseReportFile([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 setCloseReportFile([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

File name of the report to be saved and/or printed by customer. A value (a name for the file) has to be assigned to this property if CloseReportType is set to a value other than 0 (Unspecified) when CloseGroundShipments is called. Depending on the value assigned to CloseReportType, the server response will include only one of the following reports: Manifest, MultiweightReport, COD Report or HazMatCertificate. The contents of any of these reports are written to disk in CloseReportFile. The file name must have the TXT extension.

This property is applicable for FedEx Ground services only.

Data Type

String