The response body is of type object.

Returns a JSON array that contains the inventory records that match the filter parameters. If no matching records are found, an empty array is returned.

The following properties are returned:

ent_id (integer)

The entity ID.

item_id (string)

The item ID.

description (string)

The entity description.

item_desc (string)

The item description.

item_display (string)

An enumeration that indicates what format to use when identifying the item in the user interface. The format values are defined in the system attribute Item display (attr_id 210 in the System_Attr table).

Possible values and their formats are:

0 = item_id

1 = item_desc

2 = item_id (item_desc)

3 = item_desc (item_id)

lot_no (string)

The lot number.

sublot_no (string)

The sublot number.

row_id_h (integer)

The unique identifier of the row.

qty_left (double)

The quantity left.

qty_left_erp (double)

The quantity left that has already been reported to the ERP system.

date_in_utc (datetime)

The date and time when the item was last received to this lot/location in UTC.

date_in_local (datetime)

The date and time when the item was last received to this lot/location in the local time of the entity at which the inventory was received.

date_in (datetime)

The date and time when the item was last received to this lot/location in the local time of the time zone that was specified in the tz_id parameter in the call header or URL, from the Item_Inv table. If the tz_id parameter was not provided or was not valid, then the time is in UTC.

date_out_utc (datetime)

The date and time when the item was last sent from this lot/location in UTC.

date_out_local (datetime)

The date and time when the item was last sent from this lot/location in the local time of the entity from which the transfer occurred.

date_out (datetime)

The date and time when an item was last sent from this lot/location in the local time of the time zone that was specified in the tz_id parameter in the call header or URL, from the Item_Inv table. If the tz_id parameter was not provided or was not valid, then the time is in UTC.

last_edit_at_h (datetime)

The date and time, in UTC, when the record was created or last updated.

expiry_date_utc (datetime)

The item's expiry date and time in UTC.

expiry_date_local (datetime)

The item's expiry date and time in the local time of the storage entity.

expiry_date (datetime)

The item's expiry date and time in the local time of the time zone that was specified in the tz_id parameter in the call header or URL, from the Item_Inv table. If the tz_id parameter was not provided or was not valid, then the time is in UTC.

item_grade_cd (string)

The item grade code, from the Item_Inv table.

item_grade_desc (string)

The item grade description, from the Item_Grade table.

gradecolor_h (string)

The name or hex value of the HTML color that is the item grade's color in the user interface.

item_status_cd (integer)

The item state code, from the Item_Inv table.

item_status_desc (string)

The item state description, from the Item_State table.

statuscolor_h (string)

The name or hex value of the HTML color that is the item state's color in the user interface.

ent_name (string)

The entity name, from the Ent table.

loc_status (integer)

The indication of the inventory status value at this location. For example:

0 = Available

1 = Used

2 = Dirty.

uom_id_h (integer)

The ID of the item's unit of measure (UOM), from the Item table.

inv_unique_by_job_h (Boolean)

The indication whether the item is unique by job based on the work order, operation, and sequence number.

wo_id (string)

The work order ID.

oper_id (string)

The operation ID.

seq_no (integer)

The job sequence numberle.

num_decimals_h (integer)

The number of decimal places for a quantity for this inventory.

units (string)

The description of the UOM identified in uom_id_h.

item_class_id (string)

The item class ID.

item_class_desc (string)

The item class description.

item_class_display (string)

The value that indicates what format to use when identifying the item class in the user interface. The format values are defined in the system attribute Item class display (attr_id 208 in the System_Attr table).

Possible values and their formats are:

0 = item_class_id

1 = item_class_desc

2 = item_class_id (item_class_desc)

3 = item_class_desc (item_class_id).

item_inv_uom_id (integer)

The ID of the UOM for the inventory if the inventory UOM is non-null in this inventory record. Otherwise, it is the UOM ID for the item in this record.

item_inv_uom_description (string)

The description of the UOM for inventory if the inventory UOM is non-null in this inventory record. Otherwise, it is the UOM description for the item in this record, from the UOM table.

spare1 (string)

The content of the spare1 field.

spare2 (string)

The content of the spare2 field.

spare3 (string)

The content of the spare3 field.

spare4 (string)

The content of the spare4 field.

spare5 (string)

The content of the spare5 field.

spare6 (string)

The content of the spare6 field.

inv_item_item_id_h (string)

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 of the Inv_Item_Attr table.

The item attributes that are returned are those whose visible_in_inventory is set to true, from the Attr table.

The attribute information is returned as the following column pair:

• attr<attr_id>, which is the value of the attribute whose ID is the <attr_id> part of the column name
• attr<attr_id>d_h, which is the description of the attribute whose ID is the <attr_id> part of the column name

inv_lot_item_id_h (string)

The item of the lot whose attributes are to be included in the returned array for display in the inventory grid, from inv_lot_item_id_h of the Inv_Lot_Attr table.

The lot attributes that are returned are those whose visible_in_inventory flag is set to true, from the Attr table.

The attribute information is returned as the following column pair:

• attr<attr_id>, which is the value of the attribute whose ID is the < attr_id> part of the column name
• attr<attr_id>d_h, which is the description of the attribute whose ID is the <attr_id> part of the column name

inv_lot_lot_no_h (string)

The number of the lot whose attributes are to be included in the returned array for display in the inventory grid, from inv_lot_lot_no_h of the Inv_Lot_Attr table.

The lot attributes that are returned are those whose visible_in_inventory is set to true, from the Attr table.

The attribute information is returned as the following column pair:

• attr<attr_id>, which is the value of the attribute whose ID is the <attr_id> part of the column name
• attr<attr_id>d_h, which is the description of the attribute whose ID is the <attr_id> part of the column name

To get the inventory records for items stored at the entity with the ID of 15 and related to work order 20190315.001:

api/ItemInventory?entityID=15&woId=20190315.001

To get the inventory records for the items whose ID includes bulk that are stored at any entity with silo in the name:

api/ItemInventry?entName=silo&itemId=bulk

To get the inventory records for all inventory that is due to expire at or after March 15, 2019:

api/ItemInventory?fromExpiryDate=20190315T00:00:00Z

Examples: Work Tasks Lookups

To get the inventory records for items stored at a specific entity and related to a work order:

api/ItemInventory?entityId={entiyId}&woId={woId}

To get the inventory records for all inventory that is due to expire within a time range:

api//ItemInventory?fromExpiryDate={fromExpiryDate}&toExpiryDate{toExpiryDate}

All Operations Resource Group | MES Web API V1 Web Service