V3_Item_Get (Get)
- Last UpdatedNov 06, 2025
- 4 minute read
| Get | V3_Item_Get |
Resource Path:/api/v3/Item
| Name | Description | Data Type |
|---|---|---|
| itemId | The ID of an item. | string |
| itemDesc | The description of an item. | string |
| itemClassId | The ID of an item class. | string |
| uomId | The ID of an item's unit of measure. | integer |
| template | A flag that indicates whether the item is a template to be copied (true) or an actual item (false). | boolean |
| lifetime | The life time in days of an item before it expires. | integer |
| unitCost | The per unit cost to purchase an item. | number |
| obsolete | A flag that indicates whether an item is obsolete. | boolean |
| purchased | A flag that indicates whether an item can be purchased. | boolean |
| sold | A flag that indicates whether an item can be sold. | boolean |
| numberOfDecimals | The number of decimal places to use for quantities of an item. | integer |
| mustCompleteSteps | A flag that indicates whether all steps must be completed/bypassed to end a job, regardless of the Job_Exec setting, when producing an item. | boolean |
| mustProdReqdQty | A flag that indicates whether the quantity produced must be at least equal to the quantity required to end the job, regardless of Job_Exec setting, when producing an item. | boolean |
| minGrade | The lowest grade of an item to consider it shippable. | integer |
| minState | The lowest state of an item to consider it shippable. | integer |
| minInvLevel | The minimum overall amount of an item to be kept in inventory. When this amount is reached, a replenishment order should be generated. | number |
| autoReOrder | A flag that indicates whether item inventory replenishment orders should be generated automatically. | boolean |
| lotNoFormat | The default lot number format for an item. | string |
| lastLotNo | The last lot number assigned to any of the units for an item. | string |
| maxLotSize | The maximum size of a lot for an item, in its UOM units. | number |
| subLotNoFormat | The default sublot number format for an item. | string |
| lastSubLotNo | The last sublot number assigned to any of the units for an item. | string |
| serialNoLevel | integer | |
| maxSubLotSize | The maximum size of a sublot for an item, in its UOM units. | number |
| maxOrderSize | The maximum starting quantity for a work order for an item. | number |
| minTraceInv | The minimum amount of inventory of a particular lot that will be maintained in a storage entity for which the indistinguishable_lots flag is true. Lesser amounts will be merged into another lot of the same item in the same location. | number |
| invUniqueByJob | A flag that indicates whether inventory for this item should be uniquely identified by the job that is producing it. | boolean |
| spare1 | The contents of the user-defined spare1 field. | string |
| spare2 | The contents of the user-defined spare2 field. | string |
| spare3 | The contents of the user-defined spare3 field. | string |
| spare4 | The contents of the user-defined spare4 field. | string |
| itemClassProduced | A flag that indicates whether items in an item class are produced. | boolean |
| itemClassConsumed | A flag that indicates whether items in an item class are consumed. | boolean |
| itemClassObsolete | A flag that indicates whether all items in an item class are obsolete. | boolean |
| orderByICFirst | Optional. A flag that indicates whether the returned array should be ordered by item class first or not. For more information about this parameter, see Remarks. | boolean |
| lastEditBy | A user who created or last updated an item record. | string |
| lastEditAt | A date and time when an item record was added or last updated. | string |
| Name | Description |
|---|---|
| trans_id | Used to supply the ID of the transaction if the call is taking part in a transaction. |
| max_rows | Used to supply the maximum number of rows that will be returned by the get. |
The response body is of type Array[Generated.Models.V3_Item_Get].
OKThe items to be retrieved are determined by the input parameters, all of which are used as filters. Passing no filter parameters will retrieve all items.
The sort order of records in the returned array is determined by the supplied orderByICFirst parameter.
If orderByICFirst is set to true, then the sort order if first sorted by item class based on the system attribute Item class display (attr_id 208 in the System_Attr table):
- If 0 or 2, the array is sorted by item_class_id.
- If 1 or 3, the array is sorted by item_class_desc.
The array is then sorted by item based on the system attribute Item display (attr_id 210 in the System_Attr table):
- If 0 or 2, the array is sorted by item_id.
- If 1 or 3, the array is sorted by item_desc.
If orderByICFirst is set to false, then the array is sorted only by item.