---
displayed_sidebar: inventoryReference
---

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

# FilterableInventoryItemProps

The filters to apply on retrieved inventory items.

<ParameterTypes parameters={[
  {
    "name": "hs_code",
    "type": "`string` \\| `string`[] \\| [StringComparisonOperator](inventory.StringComparisonOperator.mdx)",
    "description": "The HS Codes to filter inventory items by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "id",
    "type": "`string` \\| `string`[]",
    "description": "The IDs to filter inventory items by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "location_id",
    "type": "`string` \\| `string`[]",
    "description": "Filter inventory items by the ID of their associated location.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "origin_country",
    "type": "`string` \\| `string`[]",
    "description": "The origin country to filter inventory items by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "q",
    "type": "`string`",
    "description": "Search term to search inventory items' attributes.",
    "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`[] \\| [StringComparisonOperator](inventory.StringComparisonOperator.mdx)",
    "description": "The SKUs to filter inventory items by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />
