CommodityUnitPrice Property

Value of each QuantityUnit in Quantity of this commodity line item.

Syntax

 fedexshipintl.getCommodityUnitPrice(index, [callback])
 fedexshipintl.setCommodityUnitPrice(index,  commodityUnitPrice, [callback])

Default Value

"1.00"

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 getCommodityUnitPrice([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 setCommodityUnitPrice([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

Value of each CommodityQuantityUnit in CommodityQuantity of this commodity line item. This is used in conjunction with the CommodityQuantityUnit and CommodityQuantity. This indicates the monetary amount used to specify the worth or price of the commodity and it should be greater than zero.

For FedEx, when the shipment contains non-documents item(s) (i.e., the Documents is set to False), the CommodityUnitPrice is required to be entered for each commodity line item included in shipment. At least one commodity occurrence is required for international dutiable (non-documents) shipments.

For UPS, it is required and applicable to Invoice and Partial Invoice forms only.

For USPS, use the CommodityValue property instead.

Format: Limit to 6 digits after the decimal (e.g. 900.000000).

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

This property is not available at design time.

Data Type

String