MES Stateless API

GetInvItems(String,String,String,String,String) Method

Save PDF

TABLE OF CONTENTS

GetInvItems(String,String,String,String,String) Method

Save PDF

Last UpdatedNov 06, 2025
5 minute read

The GetInvItems() method retrieves a list of items from the inventory.

For this overload of the method, the entity is identified by its entity name and site name.

Syntax

'Declaration
 
Public Overloads Shared Function GetInvItems( _
   ByVal entName As String, _
   ByVal siteName As String, _
   ByVal itemId As String, _
   ByVal lotNo As String, _
   ByVal subLotNo As String _
) As DataSet

'Usage
 
Dim entName As String
Dim siteName As String
Dim itemId As String
Dim lotNo As String
Dim subLotNo As String
Dim value As DataSet
 
value = StorageExec.GetInvItems(entName, siteName, itemId, lotNo, subLotNo)

public static DataSet GetInvItems( 
   string entName,
   string siteName,
   string itemId,
   string lotNo,
   string subLotNo
)

Parameters

entName: Optional filter parameter. Holds the name of an entity.
siteName: Optional filter parameter. Holds the site name of an entity.
itemId: Optional filter parameter. Holds the ID of an item.
lotNo: Optional filter parameter. Holds a lot number.
subLotNo: Optional filter parameter. Holds a sublot number

Return Value

Returns a DataSet that contains a record for each item that matches the supplied filter parameters. If no matching records are found, an empty DataSet is returned.

The columns of the returned DataSet are described below.

Column Name	Description
row_id	An integer that is the unique identifier of row, from the Item_Inv table.
ent_id	An integer that is the ID of the storage entity, from the Item_Inv table
item_id	A string that is ID of the item, from the Item_Inv table.
lot_no	A string that is the lot number, from the Item_Inv table.
sublot_no	A string that is the sublot number, from the Item_Inv table.
grade_cd	An integer that is the grade code of the lot, from the Item_Inv table
status_cd	An integer that is the status code of the lot, from the Item_Inv table
ent_name	A string that is the unique entity name, from the ent.ent_name column.
item_desc	A string that is the item description, from the item.item_desc column.
item_uom_id	An integer that is the ID of the item unit of measurement (UOM), from the item.uom_id column.
item_grade_desc	A string that is the unique item grade description, from the item_grade.item_grade_desc column.
grade_color	An integer that indicates the background color, from the item_grade.color column.
item_status_desc	A string that is the unique item status description, from the item_state.item_status_desc column.
state_color	An integer that indicates the item state background color Returned from item_state.color column.
qty_left	A double that is the quantity left, from the Item_Inv table.
qty_left_erp	A double that is the quantity left that has already been reported to the ERP system, from the Item_Inv table.
uom_id	An integer that is the ID of the UOM for inventory, from the Item_Inv table.
date_in_utc	A datetime in UTC that is when an item was last received to this lot/location, from the Item_Inv table.
date_in_local	A datetime in local time that when an item was last received to this lot/location, from the Item_Inv table.
date_in	A datetime that is when, in the client’s local time, an item was last received to this lot/location, from the Item_Inv table.
date_out_utc	A datetime that is the when, in UTC, an item was last sent from this lot/location, from the Item_Inv table.
date_out_local	A datetime that is when, in local time, an item was last sent from this lot/location, from the Item_Inv table.
date_out	A datetime that is when, in the client’s local time, an item was last sent from this lot/location, from the Item_Inv table.
wo_id	A string that is the ID of the work order, from the Item_Inv table.
oper_id	A string that is operation ID, from the Item_Inv table.
seq_no	An integer that is the operation sequence number, from the Item_Inv table.
spare1	A string that is the contents of the user-defined spare1 field, from the Item_Inv table.
spare2	A string that is the contents of the user-defined spare2 field, from the Item_Inv table.
spare3	A string that is the contents of the user-defined spare3 field, from the Item_Inv table.
spare4	A string that is the contents of the user-defined spare4 field, from the Item_Inv table.
spare5	A string that is the contents of the user-defined spare5 field, from the Item_Inv table.
spare6	A string that is the contents of the user-defined spare6 field, from the Item_Inv table.
num_decimals	An integer that is the number of decimal places for a quantity, from the item.num_decimals column.
last_edit_comment	A string that contains comments about why the record was changed.
last_edit_by	A string that is the ID of the user who added or last updated this record.
last_edit_at	A datetime that indicates when the record was added or last updated.
uom_desc	A string that is the unique description of unit, from the uom.description column.
shippable_grade_h	A Boolean that is a flag that indicates whether the inventory is shippable (shippable grade).
shippable_state_h	A Boolean that is a flag that indicates whether the inventory is shippable (shippable state).
inv_item_item_id_h	A string that identifies the item whose attributes are to be included in the returned array for display in the inventory grid, from the inv_item_item_id_h column of the Inv_Item_Attr table.
inv_lot_item_id_h	A string that identifies the item of the lot whose attributes are to be included in the returned array for display in the inventory grid, from the inv_lot_item_id_h column of the Inv_Lot_Attr table.
inv_lot_lot_no_h	A string that identifies the number of the lot whose attributes are to be included in the returned array for display in the inventory grid, from the inv_lot_lot_no_h column of the Inv_Lot_Attr table.
attrn	A string that is the value of an item or lot attribute that has been assigned to the inventory, where n is the attribute ID. This column is included only if the visible_in_inventory flag of the item or lot attribute's record in the Attr table is set to true. This flag corresponds to the attribute's In Inventory Grid option in MES Client.
attrnd_h	A string that is the name of an item or lot attribute that has been assigned to the inventory, where n is the attribute ID. This column is included only if the visible_in_inventory flag of the item or lot attribute's record in the Attr table is set to true. This flag corresponds to the attribute's In Inventory Grid option in MES Client.

MES Stateless API

GetInvItems(String,String,String,String,String) Method

Table of Contents

GetInvItems(String,String,String,String,String) Method

In This Topic

MES Stateless API

GetInvItems(String,String,String,String,String) Method

Syntax

Parameters

Return Value

Remarks

See Also

Reference

In This Topic