## API Endpoint

This endpoint is accessed via this path:

```
https://app.finaleinventory.com/{accountPathComponent}/api/inventoryitem/
```

There are no filters available for this endpoint to limit the records returned or to request a specific row for a specific product or location. In order to query for specific products/sublocations, etc, you should take advantage of the special reporting API.

[How to use the Reporting API](https://developer.finaleinventory.com/reference/reporting-api-getting-started)

[Adding Filters to Report URL called by the API](https://developer.finaleinventory.com/reference/reporting-api-filtering)

## Inventory Item Service

The inventory item service provides the current stock information for an account, including quantities on hand from stock currently present at a sublocation, quantities on order from committed purchase orders, and quantities reserved from committed sale orders.

A single product might have many entries in the list representing stock information for different locations or orders. Calculating the total quantity on hand for a product may require summing various entries relating to different sublocations, lots, orders, etc.

### Entry Structure

There will be one entry in the list for each unique combination of facilityUrl, lotId, normalizedPackingString, orderUrl, and productUrl. Each entry will have a non-zero value in one of the three fields: quantityOnHand, quantityOnOrder, and quantityReserved.

- **Entries for stock currently present at a sublocation:**  
  - facilityUrl set to the sublocation  
  - lotId will be a non-empty string if the entry represents the quantity of a specific lot  
  - orderUrl will always be null  
  - quantityOnHand will be quantity at that sublocation and the other quantities will be zero.

- **Entries for stock quantities on order from committed purchase orders:**  
  - facilityUrl set to the sublocation of purchase order's destination  
  - orderUrl will reference the purchase order  
  - quantityOnOrder will be the quantity on the purchase order and the other quantities will be zero.

- **Entries for stock quantities reserved from committed purchase orders:**  
  - facilityUrl set to the sublocation of sale order's origin  
  - orderUrl will reference the sale order  
  - quantityReserved will be the quantity on the sale order and the other quantities will be zero.

The normalizedPackingString is only a non-empty string if the account uses the case packing feature in Finale and represents the case packing of the quantity in the entry.

### Fields for the Inventory Item Service

- facilityUrl
- inventoryItemUrl
- lotId
- normalizedPackingString
- orderSummaryUrl
- orderUrl
- parentFacilityUrl
- productId
- productUrl
- quantityOnHand
- quantityOnOrder
- quantityReserved

---

Updated 9 months ago