InventoryItems
This entity describes an Autotask product that is associated with an Inventory location in the Autotask Inventory module. Once an InventoryItems entity has been created, you can track quantities for that item (quantity on hand, quantity on order) and provide a value for minimum and maximum quantity for use with the Auto-Fill Order feature. You can assign serial numbers to instances of InventoryItems, add them to purchase orders, and "receive" them. You can also transfer them between inventory locations or associate them with an account. Inventory items are added and managed in Autotask through the Inventory module.
NOTE Please review the Conditions and Requirements listed below before creating or updating InventoryItems.
NOTE You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.
Entity details
Entity Name: | InventoryItems |
Entity Path: |
/atservicesrest/v1.0/InventoryItems |
Can Create: | |
Can Update: | |
Can Query: | |
Can Delete: | |
Can Have UDFs: |
IMPORTANT Requests to this entity require special handling. Refer to the Entity URLs and relationships section of this article for details.
- If this entity has a Parent relationship, you must perform all Create, Update, and Delete actions on the parent entity.
- If this entity is a child of a parent, you can leverage our Swagger instance to find the URLs you should use in your API calls. For more information, refer to Finding resource and child access URLs of REST API entities.
- To learn how to access Swagger, refer to Using Swagger UI to explore REST API requests.
Parent | None |
Children | InventoryItemSerialNumbers |
URLs | InventoryItems/query (GET, POST) InventoryItems/{id} (GET) InventoryItems/query/count (GET, POST) InventoryItems (PUT, POST, PATCH) InventoryItems/entityInformation (GET) InventoryItems/entityInformation/fields (GET) InventoryItems/entityInformation/userDefinedFields (GET) |
Conditions and requirements
General
- Inventory Add/Edit Item permission is required to Add or Edit an Inventory Item.
- To query, you must have View permission and Inventory access (site installed module access and security level feature or section access)
- To create or update, you must have View and Create permission and Inventory access (site installed module access and security level feature or section access)
- Each inventoryItem requires a unique combination of inventoryItem.productID and inventoryItem.inventoryLocationID.
Special field attributes
Field | Conditions and Requirements |
---|---|
inventoryLocationID | inventoryLocationID must reference an isActive inventory location. |
quantityMinimum | quantityMinimum must be >= 0. |
quantityMaximum | quantityMaximum must be >= quantityMinimum. |
quantityOnHand
|
quantityOnHand must be >= the quantity quantityPicked + quantity quantityReserved.
|
Field definitions
The following table describes the standard Autotask fields for this entity. Refer to the following articles for more information about working with these fields:
- The entityInformation REST API call
- Making basic query calls to the REST API
- Advanced query features of the REST API
To learn how to query picklist endpoints, refer to Understanding picklists.
Notes
- For string datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
- LT indicates Local Term.
- If this entity has child collections, they will appear in a Child collection access URLs or an Entity URLs and relationships drop-down in the Entity details section of this article.
- You can call the /query/count/ endpoint of a resource to determine how many records a collection holds.
Field Name | Datatype | Read-Only | Is Required | Reference Name | Picklist |
---|---|---|---|---|---|
backOrderQuantity | integer | ||||
bin | string (50) | ||||
id | integer | ||||
impersonatorCreatorResourceID | integer | Resources |
|
||
inventoryLocationID | integer | InventoryLocations | |||
productID | integer | Products | |||
quantityMaximum | integer | ||||
quantityMinimum | integer | ||||
quantityOnHand | integer | ||||
quantityOnOrder | integer | ||||
quantityPicked | integer | ||||
quantityReserved | integer | ||||
referenceNumber | string (50) |