Resource: inventorybywarehouse.nv
HTTP-method: GET
Note! If Rackbeat inventory management is used in Netvisor, the API documentation can be found here: https://support.netvisor.fi/en/support/solutions/articles/77000554491-rackbeat-stoplight-api
InventoryByWarehouse.nv resource allows retrieving product balances per warehouse through Netvisor's API. If detailed information about products is needed, they can be retrieved using the Tuotetietojen nouto function.
Instructions related to Netvisor's inventory management can be found here.
Parameters used in the request to limit the result set. The parameter is passed in the QueryString.
| Parameter | Occurs | Description | Example |
| productid | 0...1 | Filter search with product ID (NetvisorKey) | 123 |
| productidlist | 0...1 | Filter search with given product IDs (NetvisorKey), separated with comma | 123,456,235 |
| inventoryplaceid | 0...1 | Filter with warehouse ID | 321 |
| inventoryplacename | 0...1 | Filter with warehouse name | warehouse5 |
| limitvendorid | 0...1 | Filter with vendor ID | 105 |
| changedsince | 0...1 | Filter to changes since the given time | 1.5.2014 12:00:00 |
| limitunderalertlimit | 0...1 | 1 = return only products under alert limit | 1 |
| productgroupname | 0...1 | Limit search to given product group | example products |
Example query: https://isvapi.netvisor.fi/InventoryByWarehouse.nv?inventoryplaceid=321&limitunderalertlimit=1 (retrieve all products under alert limit from warehouse with ID 321).
Response:
| Level | Element | Type | Occurs | Description | Example |
| Root | Root | Aggregate | 1 | ||
| 1 | InventoryByWarehouse | Aggregate | 1 | ||
| 2 | Product | Aggregate | 0...n | ||
| 3 | NetvisorKey | Numeric | 1 | Product's Netvisor ID. Can be used later for example to retrieve all product information or to link the product to an invoice | 165 |
| 3 | Name | String | 1 | Product name | Test product |
| 3 | Code | String | 1 | Product code | TT |
| 3 | GroupName | String | 1 | Product's product group as text | Campaign products |
| 3 | ProductUri | String | 1 | URI for retrieving full product information through the API | /getproduct.nv?id=165 |
| 3 | Warehouse | Aggregate | |||
| 4 | NetvisorKey | Numeric | 1 | Warehouse database ID in Netvisor | 12 |
| 4 | Name | String | 1 | Warehouse name | Main warehouse |
| 4 | ReservedAmount | Numeric | 1 | Amount reserved from this warehouse (reserved) | 10,00 |
| 4 | OrderedAmount | Numeric | 1 | Amount ordered to this warehouse (incoming) | 15,00 |
| 4 | InventoryAmount | Numeric | 1 | Product's open stock balance in this warehouse (does not include reserved or incoming balances) | 34,00 |
| 3 | TotalReservedAmount | Numeric | 1 | Product's reserved balance including all warehouses | 524,00 |
| 3 | TotalOrderedAmount | Numeric | 1 | Product's incoming balance including all warehouses | 125,00 |
| 3 | TotalAmount | Numeric | 1 | Product's in-stock balance including all warehouses (does not include reserved or incoming balances) | 647,00 |
This article has been translated using an AI-based translation tool. The contents or wording of these instructions may differ from those in other instructions or in the software.
Did you find it helpful? Yes No
Send feedbackSorry we couldn't be helpful. Help us improve this article with your feedback.
