WinShopAPI docs
Reference

Stock items

Create stock items

Creates the stock items for every combination of `warehouseId` and `productId` that does not have one yet, and returns the rows it created (201, `Location` header set). Returns 200 with no body when every combination already existed. Requires `Permissions.StockItems.View`.

Search stock items

Returns one page of stock items matching the filter. A stock item is one product's holding in one warehouse. Body is a `PaginationRequest` — see the *Filtering & pagination* concept in the developer docs. Sortable and limitable fields depend on the instance's data-grid view. Requires `Permissions.StockItems.View`.

Get a stock item

Returns one stock item by `stockItemId`, with its quantities for the product/warehouse pair. Requires `Permissions.StockItems.View`.

Update a stock item

Updates the stock item's editable fields — such as its minimum and maximum stock levels and shelf location — and returns the stored row. Quantities move through documents, not through this endpoint. Requires `Permissions.StockItems.View`.

List blocking documents

Returns the unprocessed documents holding part of this stock item. Blocked goods are quantities that physically sit in the warehouse but are already promised elsewhere, so they are not available to sell. Requires `Permissions.StockItems.View`.

List blocking customer orders

Returns the customer orders holding part of this stock item. Blocked goods are quantities that physically sit in the warehouse but are already promised elsewhere, so they are not available to sell. Requires `Permissions.StockItems.View`.

List blocking e-shop orders

Returns the e-shop orders holding part of this stock item. Blocked goods are quantities that physically sit in the warehouse but are already promised elsewhere, so they are not available to sell. Requires `Permissions.StockItems.View`.

List blocking internal orders

Returns the internal orders holding part of this stock item. Blocked goods are quantities that physically sit in the warehouse but are already promised elsewhere, so they are not available to sell. Requires `Permissions.StockItems.View`.

List blocking supplier orders

Returns the supplier orders holding part of this stock item. Blocked goods are quantities that physically sit in the warehouse but are already promised elsewhere, so they are not available to sell. Requires `Permissions.StockItems.View`.

List blocking reservations

Returns the reservations holding part of this stock item. Blocked goods are quantities that physically sit in the warehouse but are already promised elsewhere, so they are not available to sell. Requires `Permissions.StockItems.View`.

List a stock item's movements

Returns the stock movements booked against this stock item, optionally narrowed to the window between `dateFrom` and `dateTo`. Requires `Permissions.StockItems.View`.