CloseReportType Property
Indicates what type of report(s) from the last 3 days are to be returned in a report-only close operation request.
Syntax
fedexship.getCloseReportType([callback]) fedexship.setCloseReportType( closeReportType, [callback])
Possible Values
0 (crtUnspecified), 1 (crtManifest), 2 (crtCOD), 3 (crtHazMat), 4 (crtMultiweight)
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 getCloseReportType([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 setCloseReportType([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
Indicates what type of report(s) from the last 3 days are to be returned in a report-only close operation request.
If this is set to a value other than 0 (Unspecified), the server with return that specific report from the last three closed shipping days. Otherwise, the server will return the shipment manifest along with all applicable reports.
When requesting a certain type of report, only one type can be returned per Close request. If you need multiple report types you will have to issue multiple CloseGroundShipments requests.
Valid report types are listed below:
Type | Meaning |
crtUnspecified (0) | The Close operation is requested to be processed, but no specific report is requested |
crtManifest (1) | Only the Ground Manifest Report is requested |
crtCOD (2) | Only the Ground COD Report is requested |
crtHazMat (3) | Only the Ground Hazardous Materials Report is requested |
crtMultiweight (4) | Only the Ground Multiweight Report is requested |
This property is applicable for FedEx Ground services only.
NOTE: This only takes effect when calling ReprintDocuments.
Data Type
Integer