InventoryStockedItems

This entity describes detailed information about on-hand InventoryProducts at a location.

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: InventoryStockedItems

Entity Path:

/atservicesrest/v1.0/inventoryStockedItems
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.

Parent InventoryProducts
Children None
URLs InventoryStockedItems/{id} (GET)
InventoryStockedItems/query (GET, POST)
InventoryStockedItems/query/count (GET, POST)
InventoryStockedItems/entityInformation (GET)
InventoryStockedItems/entityInformation/fields (GET)

Fields that cannot be queried

The following fields from this entity will return an error when queried.

  • parentStockedItemReceivedUnits

Conditions and requirements

General

  • inventoryProducts cannot be deleted if the reservedUnits or pickedUnits values are greater than 0.

  • Following the release of Autotask 2022.1, it is no longer possible to update the quantity on hand of an inventory product. The field is now calculated based on the stocked items as follows:

    • To increase the quantity on hand of a product in inventory, you'll need to send a Create request to the InventoryStockedItemsAdd endpoint for the product to increase.

      • For serialized items, each serial number requires a new Create request against InventoryStockedItemsAdd. Only one serial number can exist per row.

    • To decrease the quantity on hand of a product in inventory, you'll need to send an Update request to the InventoryStockedItemsRemove endpoint for the product to decrease.

      • If the product is serialized, you'll need to query InventoryStockedItems for the serial number. Set the quantityOnHand value to 0 and the quantityRemoved value to 1. If required, reasonForUpdate must also be included.

      • If the product is not serialized, query InventoryStockedItems for the product associated with the inventory location. The query may return multiple rows. Decide which of the resulting rows will be updated. We recommend reducing the quantity from the oldest item.

    • For serialized items, the sum of onHandUnits, reservedUnits, transferredUnits, removedUnits, pickedUnits, and deliveredUnits will always equal 1.

    • For non-serialized items, the sum of onHandUnits, reservedUnits, transferredUnits, removedUnits, pickedUnits, and deliveredUnits is always equal to the value of the purchaseOrderItemReceiving.quantityPreviouslyReceived field.

  • To determine the original received quantity, query the PurchaseOrderItemReceiving entity.

Special field attributes

Field Conditions and Requirements
serialNumber This field can only be updated for serialized products/
statusID This field can only be updated for serialized products.
returnPrice You can only update this field if the returnTypeID value is not null.

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:

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
availableUnits integer      
companyID integer   Companies  
configurationItemID integer   ConfigurationItems  

contractChargeID

integer

 

ContractCharges

 
costProductID integer      
createDateTime datetime      
createdByResourceID integer   Resources  
currentInventoryLocationID integer   Resources
deliveredUnits integer      
id long    
inventoryProductID integer InventoryProducts  
onHandUnits integer      
parentInventoryStockItemID integer   InventoryStockedItems  

parentStockedItemReceivedUnits

integer

 

 

 
pickedRemovedByResourceID integer   Resources  
pickedRemovedDateTime datetime      
pickedUnits integer      

projectChargeID

integer

 

ProjectCharges

 
purchaseOrderID integer      
purchaseOrderItemID integer      
purchaseOrderItemReceivingID integer   PurchaseOrderItemReceiving  
quoteItemID integer   QuoteItems  
removedUnits integer      
reservedUnits integer      
returnPrice decimal        
returnTypeID integer    
serialNumber string (50)        
statusID integer      

ticketChargeID

integer

 

TicketCharges

 
transferredUnits integer      
unitCost decimal      
vendorID integer      
vendorInvoiceNumber string (50)        

Additional resources