lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #17413 from kastoras/product_api_get_product_stock

Browse Source 
Close/CLOSE #13739 Product API route added to get product stock
This commit is contained in:
Laurent Destailleur 2021-04-28 15:31:33 +02:00 committed by GitHub
commit 0b0d1ee832
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 45 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
htdocs/product/class/api_products.class.php
View File

@ -1793,6 +1793,51 @@ class Products extends DolibarrApi
return $result;
}
/**
* Get stock data for the product id given.
* Optionaly with $selected_warehouse_id parameter user can get stock of specific warehouse
*
* @param int $id ID of Product
* @param int $selected_warehouse_id ID of warehouse
* @return int
*
* @throws RestException 500
* @throws RestException 401
* @throws RestException 404
*
* @url GET {id}/stock
*/
public function getStock($id, $selected_warehouse_id = null)
{
if (!DolibarrApiAccess::$user->rights->produit->lire) {
throw new RestException(401);
}
if (!DolibarrApi::_checkAccessToResource('product', $id)) {
throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
}
$product_model = new Product($this->db);
$product_model->fetch($id);
$product_model->load_stock();
$stockData = $this->_cleanObjectDatas($product_model)->stock_warehouse;
if ($selected_warehouse_id) {
foreach ($stockData as $warehouse_id => $warehouse) {
if ($warehouse_id != $selected_warehouse_id) {
unset($stockData[$warehouse_id]);
}
}
}
if (empty($stockData)) {
throw new RestException(404, 'No stock found');
}
return ['stock_warehouses'=>$stockData];
}
// phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
/**
* Clean sensible object datas