getmatrixinfo

4.3 ww.dll API Reference : API descriptions : Functions with database access : getmatrixinfo

getmatrixinfo

Description

getmatrixinfo takes <department>, <category>, <item> and the optional <fields> parameters and returns a table of matrix information for a Retail module item that has been configured as a matrix item. The result set returned is ordered according to the order defined in the inventory matrix template.

Input fields

XML tag	Description
<department>	<item> department.
<category>	<item> category.
<item>	Item.
<fields>	Optional. See Note on the <fields> tag. Available columns for the <fields> tag include all of the columns in the i_items (i_it prefix) and i_invent (i_in prefix) tables. If the <fields> tag is not present, the function returns: i_it.descrip, i_it.invent_id and i_in.quantity for the given DCI.

Return fields

Table of matrix information for the matrix item. If the DCI passed is not a matrix item, the function returns: ERR:Function getmatrixinfo did not return information.

Field	Description
invent_id	Inventory ID.
quantity	Sum of all the quantities in i_invent and are equal the quantity on hand.
value1	Value for the matrix attributes for the item; primary axis of the matrix.
value2	Value for the matrix attributes for the item.
label1	Names of the attributes corresponding to value1.
label2	Names of the attributes corresponding to value2.

Example

Example invocation:

<func>getmatrixinfo</func><department>retail</department><category>menscloth</category><item>qkslvshirt</item>

Example return string (formatted):