Endpoint
GET /inventoriesAuthentication
Required: Authorization header with valid token
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| search | string | No | Search by title or ID number (case-insensitive) | Excavator |
| productId | uuid | No | Filter by specific product | 123e4567-e89b-12d3-a456-426614174000 |
| sortBy | string | No | Field to sort by | updatedAt |
| sortDirection | string | No | Sort direction (ASC or DESC) | DESC |
| ids | string | No | Comma-separated list of inventory IDs to filter | uuid1,uuid2 |
| fields | string | No | Comma-separated list of fields to select | title,idNumber |
| warehouseIds | string | No | Comma-separated warehouse IDs to filter stock calculations | uuid1,uuid2 |
| externalId | string | No | Filter by external identifier | external-inventory-123 |
| page | number | No | Page number (default: 1) | 1 |
| limit | number | No | Items per page (default: 20) | 20 |
| expand | string | No | Expand entity with passed comma separated relation entities | stocks |
Response
Success (200)
{
"content": [
"InventoryEntity"
],
"total": "number"
}Response Field Descriptions:
content- Array of inventory objects (InventoryEntity Schema)total- Total number of inventories matching the query criteria
Error
See Error Schema documentation
Example Usage
Bash
curl -X GET "https://integration-api.ram.syniotec.com/master-data/v1/inventory-management/inventories" \
-H "Authorization: Bearer YOUR_TOKEN"