Method list

Test your request

Changelog

The method allows you to retrieve a paginated list of stocktakes from BaseLinker storage. It supports filtering by stocktake, warehouse, status, series, number, and creation date range.

filter_stocktake_id	int	(optional) Filter by a specific stocktake identifier
filter_warehouse_id	int	(optional) Filter by warehouse identifier
filter_stocktake_status	int	(optional) Filter by stocktake status: 0 - draft, 1 - commissioned, 2 - in progress, 3 - completed, 4 - counted, 5 - rejected
filter_series_id	int	(optional) Filter by numbering series identifier
filter_stocktake_number	varchar(50)	(optional) Filter by stocktake number (partial match)
filter_date_from	int	(optional) Minimum creation date (unix timestamp)
filter_date_to	int	(optional) Maximum creation date (unix timestamp)
page	int	(optional) Results page number (100 stocktakes per page, numbered from 1)

The method returns the data in JSON format.

status	varchar(30)	SUCCESS - request executed correctly ERROR - an error occurred during an API request. Error details will be described in 2 additional returned fields: error_message and error_code
stocktakes	array	List of stocktakes
| - stocktake_id	int	Stocktake identifier
| - stocktake_number	varchar(50)	Full stocktake document number
| - name	varchar(80)	Stocktake name
| - stocktake_status	int	Stocktake status: 0 - draft, 1 - commissioned, 2 - in progress, 3 - completed, 4 - counted, 5 - rejected
| - series_id	int	Numbering series identifier
| - warehouse_id	int	Warehouse identifier
| - priority	int	Priority: 0 - low, 1 - medium, 2 - high, 3 - urgent
| - assigned_to	int	Assigned employee identifier. 0 if not assigned.
| - items_count	int	Total number of items in the stocktake
| - verified_items_count	int	Number of items that have been verified (counted)
| - total_quantity	int	Total expected quantity of products
| - verified_total_quantity	int	Total verified (actually counted) quantity
| - compliant_items_count	int	Number of items where verified quantity matches expected quantity
| - not_compliant_items_count	int	Number of items where verified quantity differs from expected quantity
| - missing_items_count	int	Number of items with expected stock > 0 but verified quantity = 0
| - date_created	int	Stocktake creation date (unix timestamp)
| - date_completed	int	Stocktake completion date (unix timestamp). 0 if not completed.
| - date_scheduled	int	Execution scheduled date (unix timestamp). 0 if not set.
| - date_due	int	Execution due date (unix timestamp). 0 if not set.
| - notes	text	Stocktake notes
| - items_preparation_status	text	Stocktake items preparation status: ready, pending, or error

Input data:
{ "filter_warehouse_id": 205, "filter_stocktake_status": 0, "filter_date_from": 1693459200, "page": 1 } Output data:
{ "status": "SUCCESS", "stocktakes": [ { "stocktake_id": 789, "stocktake_number": "ST/1/03/2026", "name": "Monthly full stocktake", "stocktake_status": 0, "series_id": 12, "warehouse_id": 205, "priority": 1, "assigned_to": 15, "items_count": 250, "verified_items_count": 0, "total_quantity": 5000, "verified_total_quantity": 0, "compliant_items_count": 0, "not_compliant_items_count": 0, "missing_items_count": 0, "date_created": 1740479190, "date_completed": 0, "date_scheduled": 1740479190, "date_due": 1740565590, "notes": "", "items_preparation_status": "ready" } ] } A sample request in PHP:
<?php $methodParams = '{ "filter_warehouse_id": 205, "filter_stocktake_status": 0, "filter_date_from": 1693459200, "page": 1 }'; $apiParams = [ "method" => "getInventoryStocktakes", "parameters" => $methodParams ]; $curl = curl_init("https://api.baselinker.com/connector.php"); curl_setopt($curl, CURLOPT_POST, 1); curl_setopt($curl, CURLOPT_HTTPHEADER, ["X-BLToken: xxx"]); curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($apiParams)); $response = curl_exec($curl);