Method list

Test your request

Changelog

This method allows you to retrieve information about available inventory document series in Base. Each series can be linked to a specific warehouse and can have its own numbering format settings.

warehouse_id

int

(optional) Filter series by warehouse ID

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
document_series	array	List of document series
| - document_series_id	int	Document series identifier
| - name	varchar(20)	Document series name
| - document_type	int	The type of document for which this series is intended: 0-GR, 1-IGR, 2-GI, 3-IGI, 4-IT, 5-OB
| - warehouse_id	int	The warehouse ID to which this series applies
| - format	varchar(30)	Document number format pattern

Input data:
{ "warehouse_id": 205 } Output data:
{ "status": "SUCCESS", "document_series": [ { "document_series_id": 3, "name": "GRN", "document_type": 1, "warehouse_id": 205, "format": "%N/%M/%Y/GR" }, { "document_series_id": 4, "name": "GIN", "document_type": 2, "warehouse_id": 205, "format": "%N/%M/%Y/GR" } ] } A sample request in PHP:
<?php $methodParams = '{ "warehouse_id": 205 }'; $apiParams = [ "method" => "getInventoryDocumentSeries", "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);