# InventoryLevelsRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**group_by** | **string[]** | Categories by which to aggregate returned inventory levels. **Deprecated**: Removed in 2026-04. Use &#x60;group_variants&#x60; instead. | [optional]
**include_composites** | **bool** | Include composite products in the response. | [optional] [default to false]
**include_inactive** | **bool** | Include inactive products in the response. | [optional] [default to false]
**location_ids** | **string[]** | Optional outlet IDs to filter response by. | [optional]
**offset** | **int** | How many inventory levels to skip. | [optional] [default to 0]
**out_of_stock_only** | **bool** | Only return inventory levels with zero or fewer units available to sell. **Deprecated**: Removed in 2026-04. Use &#x60;to_be_procured_only&#x60; instead. | [optional] [default to false]
**product_ids** | **string[]** | Optional product IDs to filter response by. | [optional]
**root_product_ids** | **string[]** | Optional root product IDs to filter response by. | [optional]
**size** | **int** | How many inventory levels to return. | [optional] [default to 100]
**sort_direction** | **string** | Whether to sort the response ascending or descending. | [optional] [default to 'desc']
**sort_type** | **string** | Which response field to sort by. | [optional] [default to 'total_count']
**supplier_ids** | **string[]** | Optional supplier IDs to filter response by. | [optional]

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
