medusa-store/www/apps/docs/content/references/medusa/classes/medusa.AdminGetReservationsParams.mdx

---
displayed_sidebar: homepage
---

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

# AdminGetReservationsParams

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

## Properties

<ParameterTypes parameters={[
  {
    "name": "created_at",
    "type": "[DateComparisonOperator](medusa.DateComparisonOperator.mdx)",
    "description": "Date filters to apply on the reservations' `created_at` field.",
    "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": "created_by",
    "type": "`string`[]",
    "description": "\"Create by\" user IDs to filter reservations by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "description",
    "type": "`string` \\| [StringComparisonOperator](medusa.StringComparisonOperator.mdx)",
    "description": "String filters tp apply on the reservations' `description` field.",
    "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": "inventory_item_id",
    "type": "`string`[]",
    "description": "Inventory item IDs to filter reservations by.",
    "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": "line_item_id",
    "type": "`string`[]",
    "description": "Line item IDs to filter reservations by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "location_id",
    "type": "`string` \\| `string`[]",
    "description": "Location IDs to filter reservations 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": "quantity",
    "type": "[NumericalComparisonOperator](medusa.NumericalComparisonOperator.mdx)",
    "description": "Numerical filters to apply on the reservations' `quantity` field.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "gt",
        "type": "`number`",
        "description": "The filtered number must be greater than this value.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "gte",
        "type": "`number`",
        "description": "The filtered number must be greater than or equal to this value.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "lt",
        "type": "`number`",
        "description": "The filtered number must be less than this value.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "lte",
        "type": "`number`",
        "description": "The filtered number 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"/>