Links
Comment on page
📦

Stocks

This page provides a description of the available API routes for managing stocks.
Each Product (represented by Plu model) is associated with stock through its StockName property. Stocks are represented by Stock class and uniquely identified by their names (stock.Name property). A stock can group multiple products (e.g. stock called "Menu" that contains products that can be listed in cash register and stock called "Material" that contains raw materials and other resources in kitchen). Each product has a unique code (plu.Code property) within its respective stock.

API methods

get
http://{server-address}
/stocks
Get stocks
get
http://{server-address}
/stocks/{name}
Get stock by name
post
http://{server-address}
/stocks
Create stock
put
http://{server-address}
/stocks/{name}
Create or update stock
delete
http://{server-address}
/stocks/{name}
Delete stock by name