---
displayed_sidebar: homepage
---

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

# AdminListOrdersSelector

Filters to apply on the retrieved orders.

## Properties

<ParameterTypes parameters={[
  {
    "name": "canceled_at",
    "type": "[DateComparisonOperator](medusa.DateComparisonOperator.mdx)",
    "description": "Date filters to apply on the orders' `canceled_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": "cart_id",
    "type": "`string`",
    "description": "Cart ID to filter orders by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "created_at",
    "type": "[DateComparisonOperator](medusa.DateComparisonOperator.mdx)",
    "description": "Date filters to apply on the orders' `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": "Currency code to filter orders by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "customer_id",
    "type": "`string`",
    "description": "Customer ID to filter orders by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "display_id",
    "type": "`string`",
    "description": "Display ID to filter orders by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "email",
    "type": "`string`",
    "description": "Email to filter orders by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "fulfillment_status",
    "type": "`string`[]",
    "description": "Fulfillment statuses to filter orders by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "id",
    "type": "`string`",
    "description": "ID to filter orders by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "payment_status",
    "type": "`string`[]",
    "description": "Payment statuses to filter orders by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "q",
    "type": "`string`",
    "description": "Search term to search orders' shipping address, first name, email, and display ID.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "region_id",
    "type": "`string` \\| `string`[]",
    "description": "Regions to filter orders by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "sales_channel_id",
    "type": "`string`[]",
    "description": "Sales channel IDs to filter orders by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "status",
    "type": "`string`[]",
    "description": "Statuses to filter orders by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "tax_rate",
    "type": "`string`",
    "description": "Tax rate to filter orders by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "updated_at",
    "type": "[DateComparisonOperator](medusa.DateComparisonOperator.mdx)",
    "description": "Date filters to apply on the orders' `updated_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"/>
