# InventoryLevelsRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**group_variants** | **bool** | If filtering by &#x60;root_product_ids&#x60; and &#x60;group_variants&#x60; is true, one aggregated level will be returned for each variant family at each outlet. | [optional] [default to false]
**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]
**product_ids** | **string[]** | Optional product IDs to filter response by. Mutually exclusive with &#x60;root_product_ids&#x60;. When omitted, returns inventory levels for all products. | [optional]
**root_product_ids** | **string[]** | Optional root product IDs to filter response by. Mutually exclusive with &#x60;product_ids&#x60;. When omitted, returns inventory levels for all products. | [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]
**to_be_procured_only** | **bool** | Only include inventory with a positive quantity to procure. | [optional] [default to false]

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