Available Inventory
- Get Available Inventory Object Definition
- List Available Inventory
- List Available Inventory (Legacy)
- Get Available Inventory
NEW!
You can get available quantities for tracked items per serial number, lot number, bin number, and so forth.
Get Available Inventory Object Definition
lookup
List all the fields and relationships for the available inventory object:
<lookup>
<object>AVAILABLEINVENTORY</object>
</lookup>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use AVAILABLEINVENTORY |
docparid | Optional | string | Used to indicate the document type, such as Inventory Transfer , Sales Order , Purchase Order and so forth . You must use this to take advantage of any custom fields on the specified document type. |
List Available Inventory
query
List information including the lot number, expiration date, and quantity remaining for the vit-multi-033 item:
<query>
<object>AVAILABLEINVENTORY</object>
<select>
<field>ITEMID</field>
<field>WAREHOUSEID</field>
<field>BINKEY</field>
<field>LOTNO</field>
<field>EXPIRATIONDATE</field>
<field>QUANTITYLEFT</field>
</select>
<filter>
<equalto>
<field>ITEMID</field>
<value>vit-multi-033</value>
</equalto>
</filter>
</query>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use AVAILABLEINVENTORY |
select | Required | sequence | One or more field names and an optional aggregate function such as count or sum . Returning all fields is not supported. |
filter | Optional | object | Query filter expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL). |
orderby | Optional | object | Provide an order element with a field name and choose an ascending or descending sort order, for example: <order> <field>RECORDNO</field> <descending/> </order> |
options | Optional | object | Set the caseinsensitive element to true for a case-insensitive query: <caseinsensitive>true</caseinsensitive> In a multi-entity company, set the showprivate element to true to query data in private entities: <showprivate>true</showprivate> |
pagesize | Optional | integer | Custom page size between 1 and 2000 items (Default: 100 ) |
offset | Optional | integer | Point at which to start indexing into records (Default: 0 ) |
docparid | Optional | string | Document type, such as Sales Order , Purchase Order , or Inventory Transfer |
List Available Inventory (Legacy)
readByQuery
<readByQuery>
<object>AVAILABLEINVENTORY</object>
<fields>*</fields>
<query></query>
<pagesize>100</pagesize>
</readByQuery>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use AVAILABLEINVENTORY |
fields | Optional | string | Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value. |
query | Required | string | SQL-like query based on fields on the object. The following operators are supported: < , > , >= , <= , = , like , not like , in , not in , IS NOT NULL , IS NULL , AND , OR . Illegal XML characters must be properly encoded, and single quotes must be escaped with backslashes ('Jane\'s Deli' ). Joins are not supported. |
pagesize | Optional | integer | Custom page size between 1 and 1000 items (Default: 100 ) |
Get Available Inventory
read
<read>
<object>AVAILABLEINVENTORY</object>
<keys>2</keys>
<fields>*</fields>
</read>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use AVAILABLEINVENTORY |
keys | Required | string | Object RECORDNO to get |
fields | Optional | string | Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value. |