CommodityNumberOfPieces Property

The total number of packages, cartons, or containers for the commodity line item.

Syntax

 fedexfreightship.getCommodityNumberOfPieces(index, [callback])
 fedexfreightship.setCommodityNumberOfPieces(index,  commodityNumberOfPieces, [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 getCommodityNumberOfPieces([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 setCommodityNumberOfPieces([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

The total number of packages, cartons, or containers for the commodity line item.

If the Documents is set to False in ship request, the CommodityNumberOfPieces is required to be entered for each commodity item included in an international shipment. At least one occurrence is required for international dutiable (non-documents) shipments.

The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

Integer