ItemDiscountRate Property

Rate of the discount for each line item (if any).

Syntax

 level3.getItemDiscountRate(index, [callback])
 level3.setItemDiscountRate(index,  itemDiscountRate, [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 getItemDiscountRate([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 setItemDiscountRate([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

Rate of the discount for each line item (if any).

This property contains the discount percentage applied by the merchant to this line item. This property should be empty (or zero) if the ItemUnitCost reflects a discount price or if no line item discount applies.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the LineItemCount property.

This property is not available at design time.

Data Type

String