---
displayed_sidebar: homepage
---

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

# StoreGetProductsParams

Parameters used to filter and configure the pagination of the retrieved products.

## Properties

<ParameterTypes parameters={[
  {
    "name": "cart_id",
    "type": "`string`",
    "description": "Retrieve prices for a cart ID.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "category_id",
    "type": "`string`[]",
    "description": "Filter products by their associated product category's ID.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "collection_id",
    "type": "`string`[]",
    "description": "Filter products by their associated product collection's ID.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "created_at",
    "type": "[DateComparisonOperator](medusa.DateComparisonOperator.mdx)",
    "description": "Date filters to apply on the products' `created_at` date.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "gt",
        "type": "`Date`",
        "description": "The filtered date must be greater than this value.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "gte",
        "type": "`Date`",
        "description": "The filtered date must be greater than or equal to this value.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "lt",
        "type": "`Date`",
        "description": "The filtered date must be less than this value.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "lte",
        "type": "`Date`",
        "description": "The filtered date must be less than or equal to this value.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "currency_code",
    "type": "`string`",
    "description": "Retrieve prices for a currency code.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "description",
    "type": "`string`",
    "description": "Description to filter products by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "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": "handle",
    "type": "`string`",
    "description": "Handle to filter products by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "id",
    "type": "`string` \\| `string`[]",
    "description": "IDs to filter products by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "include_category_children",
    "type": "`boolean`",
    "description": "Whether to include product category children in the response.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "featureFlag": "product_categories",
    "children": []
  },
  {
    "name": "is_giftcard",
    "type": "`boolean`",
    "description": "Filter products by whether they're gift cards.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "limit",
    "type": "`number`",
    "description": "Limit the number of items returned in the list.",
    "optional": true,
    "defaultValue": "100",
    "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": "order",
    "type": "`string`",
    "description": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "q",
    "type": "`string`",
    "description": "Search term to search products' title, description, variants' title and sku, and collections' title.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "region_id",
    "type": "`string`",
    "description": "Retrieve prices for a region ID.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "sales_channel_id",
    "type": "`string`[]",
    "description": "Filter products by their associated sales channels' ID.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "tags",
    "type": "`string`[]",
    "description": "Filter products by their associated tags' value.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "title",
    "type": "`string`",
    "description": "Title to filter products by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "type_id",
    "type": "`string`[]",
    "description": "Filter products by their associated product type's ID.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "updated_at",
    "type": "[DateComparisonOperator](medusa.DateComparisonOperator.mdx)",
    "description": "Date filters to apply on the products' `created_at` date.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "gt",
        "type": "`Date`",
        "description": "The filtered date must be greater than this value.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "gte",
        "type": "`Date`",
        "description": "The filtered date must be greater than or equal to this value.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "lt",
        "type": "`Date`",
        "description": "The filtered date must be less than this value.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "lte",
        "type": "`Date`",
        "description": "The filtered date must be less than or equal to this value.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  }
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
