Resource: inventorybywarehouse.nv
HTTP-method: GET
Note! If you are using Rackbeat inventory management in Netvisor, the API documentation can be found here: https://support.netvisor.fi/en/support/solutions/articles/77000554491-rackbeat-stoplight-api
This resource allows retrieving product inventory for each warehouse. If detailed information about a product is needed, they can be retrieved with Get product details.
Querystring parameters:
Parameter | Occurs | Description | Example |
productid | 0...1 | Filter search with productid (Netvisor key) | 123 |
productidlist | 0...1 | Filter search with several product id's (Netvisor key), separated with comma | 123,456,789 |
inventoryplaceid | 0...1 | Filter with inventory ID | 321 |
inventoryplacename | 0...1 | Filter with inventory name | warehouse 5 |
limitvendorid | 0..1 | Filter with vendor's ID | 105 |
changedsince | 0...1 | Filter to changes since the time given | 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 group |
Example query:
https://isvapi.netvisor.fi/InventoryByWarehouse.nv?inventoryplaceid=321&limitunderalertlimit=1
(retrieve products under alert limit from inventory with id 321)
Response:
Level | Element name | Type and length | Occurs | Description | Example |
root | Root | Aggr. | |||
1 | InventoryByWarehouse | Aggr. | 1 | ||
2 | Product | Aggr. | 0...n | ||
3 | NetvisorKey | Numeric | 1 | Product's ID in the database, can be used to retrieve full product information or to link the product to an invoice | 165 |
3 | Name | String | 1 | Product name | Test product |
3 | Code | String | 1 | Product's code | TT |
3 | GroupName | String | 1 | Productgroup | campaign products |
3 | ProductUri | String | 1 | URI for retrieving full product information | /getproduct.nv?id=165 |
3 | Warehouse | Aggr. | |||
4 | NetvisorKey | Numeric | 1 | Warehouse's ID | 12 |
4 | Name | String | 1 | Warehouse's name | Main warehouse |
4 | ReservedAmount | Numeric | 1 | Amount reserved from this warehouse | 10,00 |
4 | OrderedAmount | Numeric | 1 | Amount ordered to this warehouse | 15,00 |
4 | InventoryAmount | Numeric | 1 | Amount of product in this warehouse | 34,00 |
3 | TotalReservedAmount | Numeric | 1 | Amount of reserved from all warehouses | 524,00 |
3 | TotalOrderedAmount | Numeric | 1 | Amount ordered from all warehouses | 125,00 |
3 | TotalAmount | Numeric | 1 | Amount of product in all warehouses | 647,00 |
Did you find it helpful? Yes No
Send feedback