LineItemId Property

Id of the Line Item.

Syntax

 item.getLineItemId(index, [callback])
 item.setLineItemId(index,  lineItemId, [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 getLineItemId([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 setLineItemId([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

Id of the Line Item.

Line Items are only available for Item ItemTypes itInventoryAssembly and itGroup. For Inventory Assemblies, Line Items consist of "ItemInventoryAssemblyLine" aggregates. For Groups, Line Items consists of "ItemGroupLine" aggregates.

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

This property is not available at design time.

Data Type

String