Storage locations: places where stock of materials and products is kept. Storage locations are created and configured in Controlata; via the API they are read only.
The method returns the company's storage locations with their storage settings, sorted by name. There are usually few storage locations, so the list is returned in full.
v1/storages/get_list.php
No parameters.
Response
An array storages with the storage location's fields:
| Field | Type | Description |
|---|---|---|
| id | int | Storage location ID |
| name | string | Name |
| materials | string | Which materials are kept here: "all", "categories" (only the selected categories) or "none" |
| materials_categories | array | Selected material categories, objects with id and name. Non-empty only if materials is "categories" |
| products | string | Which products are kept here, the same values |
| products_categories | array | Selected product categories, objects with id and name. Non-empty only if products is "categories" |
| notes | string | Notes |
Example response
{
"success": true,
"storages": [
{
"id": 3998,
"name": "Main",
"materials": "all",
"materials_categories": [],
"products": "all",
"products_categories": [],
"notes": ""
},
{
"id": 4001,
"name": "Hardware store",
"materials": "categories",
"materials_categories": [
{ "id": 12, "name": "Fasteners" },
{ "id": 13, "name": "Hinges" }
],
"products": "none",
"products_categories": [],
"notes": ""
}
]
}