---
displayed_sidebar: homepage
---

import ParameterTypes from "@site/src/components/ParameterTypes"

# AdminGetInventoryItemsParams

Parameters used to filter and configure the pagination of the retrieved inventory items.

## Properties

<ParameterTypes parameters={[
  {
    "name": "expand",
    "type": "`string`",
    "description": "Comma-separated relations that should be expanded in the returned data.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "fields",
    "type": "`string`",
    "description": "Comma-separated fields that should be included in the returned data.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "height",
    "type": "`number` \\| [NumericalComparisonOperator](medusa.NumericalComparisonOperator.mdx)",
    "description": "Number filters to apply to inventory items' `height` field.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "hs_code",
    "type": "`string` \\| `string`[] \\| [StringComparisonOperator](medusa.StringComparisonOperator.mdx)",
    "description": "String filters to apply to inventory items' `hs_code` field.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "id",
    "type": "`string` \\| `string`[]",
    "description": "IDs to filter inventory items by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "length",
    "type": "`number` \\| [NumericalComparisonOperator](medusa.NumericalComparisonOperator.mdx)",
    "description": "Number filters to apply to inventory items' `length` field.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "limit",
    "type": "`number`",
    "description": "Limit the number of items returned in the list.",
    "optional": true,
    "defaultValue": "20",
    "expandable": false,
    "children": []
  },
  {
    "name": "location_id",
    "type": "`string` \\| `string`[]",
    "description": "Location IDs to filter inventory items by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "material",
    "type": "`string` \\| `string`[]",
    "description": "Materials to filter inventory items by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "mid_code",
    "type": "`string` \\| `string`[]",
    "description": "MID codes to filter inventory items by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "offset",
    "type": "`number`",
    "description": "The number of items to skip when retrieving a list.",
    "optional": true,
    "defaultValue": "0",
    "expandable": false,
    "children": []
  },
  {
    "name": "origin_country",
    "type": "`string` \\| `string`[]",
    "description": "Origin countries to filter inventory items by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "q",
    "type": "`string`",
    "description": "Search terms to search inventory items' sku, title, and description.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "requires_shipping",
    "type": "`boolean`",
    "description": "Filter inventory items by whether they require shipping.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "sku",
    "type": "`string` \\| `string`[]",
    "description": "SKUs to filter inventory items by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "weight",
    "type": "`number` \\| [NumericalComparisonOperator](medusa.NumericalComparisonOperator.mdx)",
    "description": "Number filters to apply to inventory items' `weight` field.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "width",
    "type": "`number` \\| [NumericalComparisonOperator](medusa.NumericalComparisonOperator.mdx)",
    "description": "Number filters to apply to inventory items' `width` field.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
