getInventories
The method allows you to retrieve a list of catalogs available in the BaseLinker storage.
Input parameters
Output data:
A sample request in PHP:
Output data
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 |
| inventories | array | An array of available catalogs |
| | - inventory_id | int | ID of a catalog |
| | - name | varchar(100) | Catalog name |
| | - description | text | Catalog description |
| | - languages | array | An array of languages available in the inventory. |
| | - default_language | char(2) | Default language of the catalog. |
| | - price_groups | array | An array of price groups IDs available in the catalog |
| | - default_price_group | int | ID of the price group default for the catalog |
| | - warehouses | array | An array of warehouse IDs available in the catalog |
| | - default_warehouse | varchar(30) | ID of the warehouse default for the catalog |
| | - reservations | bool | Does this inventory support reservations |
| | - is_default | bool | Is this catalog a default catalog |
Sample
Input data:Output data:
A sample request in PHP: