Method list

Test your request

Changelog

The method allows you to retrieve a list of inventory transfers from BaseLinker storage. It supports pagination and optional filtering by status, warehouse, date range, and transfer type.

filter_transfer_id	int	(optional) Filter by a specific transfer ID
filter_warehouse_id	int	(optional) Filter by source warehouse ID
filter_target_warehouse_id	int	(optional) Filter by target warehouse ID
filter_transfer_status	int	(optional) Filter by transfer status: 0 - draft, 1 - commissioned, 2 - in progress, 3 - completed
filter_transfer_type	int	(optional) Filter by transfer type: 0 - replenishment, 1 - putaway transfer, 2 - location change
filter_series_id	int	(optional) Filter by numbering series identifier
filter_date_from	int	(optional) Minimum creation date (unix timestamp)
filter_date_to	int	(optional) Maximum creation date (unix timestamp)
filter_transfer_number	varchar(30)	(optional) Filter by transfer number (partial match)
page	int	(optional) Results page number (100 transfers 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
transfers	array	List of transfers
| - transfer_id	int	Transfer identifier
| - transfer_number	varchar(30)	Full transfer document number
| - name	varchar(100)	Transfer name
| - transfer_type	int	Transfer type: 0 - replenishment, 1 - putaway transfer, 2 - location change
| - transfer_status	int	Transfer status: 0 - draft, 1 - commissioned, 2 - in progress, 3 - completed
| - series_id	int	Numbering series identifier
| - warehouse_id	int	Source warehouse identifier
| - target_warehouse_id	int	Target 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	Number of items in the transfer
| - total_quantity	int	Total quantity of products
| - completed_items_count	int	Number of completed (verified) items
| - completed_total_quantity	int	Total quantity of completed items
| - compliant_items_count	int	Number of items where completed quantity matches ordered quantity
| - not_compliant_items_count	int	Number of items where completed quantity differs from ordered quantity
| - missing_items_count	int	Number of items with zero completed quantity
| - date_created	int	Transfer creation date (unix timestamp)
| - date_scheduled	int	Scheduled date (unix timestamp). 0 if not set.
| - date_due	int	Due date (unix timestamp). 0 if not set.
| - date_status_change	int	Date of last status change (unix timestamp). 0 if no status change.
| - notes	varchar(255)	Transfer notes/comments

Input data:
{ "filter_warehouse_id": 205, "filter_transfer_status": 0, "filter_date_from": 1693459200, "page": 1 } Output data:
{ "status": "SUCCESS", "transfers": [ { "transfer_id": 452, "transfer_number": "TR/1/03/2026", "name": "Stock replenishment March 2026", "transfer_type": 0, "transfer_status": 0, "series_id": 8, "warehouse_id": 205, "target_warehouse_id": 310, "priority": 2, "assigned_to": 0, "items_count": 15, "total_quantity": 120, "completed_items_count": 0, "completed_total_quantity": 0, "compliant_items_count": 0, "not_compliant_items_count": 0, "missing_items_count": 0, "date_created": 1740479190, "date_scheduled": 1740479190, "date_due": 1740565590, "date_status_change": 0, "notes": "Restock picking warehouse from high storage" } ] } A sample request in PHP:
<?php $methodParams = '{ "filter_warehouse_id": 205, "filter_transfer_status": 0, "filter_date_from": 1693459200, "page": 1 }'; $apiParams = [ "method" => "getInventoryTransfers", "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);