MultiweightReport Property

Image of a multiweight report.

Syntax

 fedexship.getMultiweightReport([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 getMultiweightReport([callback]) method is defined as:

function(err, buffer){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'buffer' is the value returned by the method.

The callback for the setMultiweightReport([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 identifies the buffer containing the multiweight report for FedEx Ground multiweight shipments.

When calling the CloseGroundShipments method, the MultiweightReport is returned when CloseReportType is set to 4 (Multiweight)..

The report is generated in TXT format. The report will automatically be saved to disk in the file designated by CloseReportFile.

This property is applicable for FedEx Ground services only.

This property is read-only.

Data Type

Buffer