---
displayed_sidebar: homepage
---

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

# StoreGetCustomersCustomerOrdersParams

Parameters used to filter and configure the pagination of 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": "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": "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": "fulfillment_status",
    "type": "[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)[]",
    "description": "Fulfillment statuses to filter orders by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "CANCELED",
        "type": "`\"canceled\"`",
        "description": "The order's fulfillments are canceled.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "FULFILLED",
        "type": "`\"fulfilled\"`",
        "description": "The order's items are fulfilled.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "NOT_FULFILLED",
        "type": "`\"not_fulfilled\"`",
        "description": "The order's items are not fulfilled.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "PARTIALLY_FULFILLED",
        "type": "`\"partially_fulfilled\"`",
        "description": "Some of the order's items, but not all, are fulfilled.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "PARTIALLY_RETURNED",
        "type": "`\"partially_returned\"`",
        "description": "Some of the order's items, but not all, are returned.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "PARTIALLY_SHIPPED",
        "type": "`\"partially_shipped\"`",
        "description": "Some of the order's items, but not all, are shipped.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "REQUIRES_ACTION",
        "type": "`\"requires_action\"`",
        "description": "The order's fulfillment requires action.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "RETURNED",
        "type": "`\"returned\"`",
        "description": "The order's items are returned.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "SHIPPED",
        "type": "`\"shipped\"`",
        "description": "The order's items are shipped.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "id",
    "type": "`string`",
    "description": "ID to filter orders by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "limit",
    "type": "`number`",
    "description": "Limit the number of items returned in the list.",
    "optional": false,
    "defaultValue": "10",
    "expandable": false,
    "children": []
  },
  {
    "name": "offset",
    "type": "`number`",
    "description": "The number of items to skip when retrieving a list.",
    "optional": false,
    "defaultValue": "0",
    "expandable": false,
    "children": []
  },
  {
    "name": "payment_status",
    "type": "[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)[]",
    "description": "Payment statuses to filter orders by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "AWAITING",
        "type": "`\"awaiting\"`",
        "description": "The order's payment is awaiting capturing.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "CANCELED",
        "type": "`\"canceled\"`",
        "description": "The order's payment is canceled.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "CAPTURED",
        "type": "`\"captured\"`",
        "description": "The order's payment is captured.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "NOT_PAID",
        "type": "`\"not_paid\"`",
        "description": "The order's payment is not paid.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "PARTIALLY_REFUNDED",
        "type": "`\"partially_refunded\"`",
        "description": "Some of the order's payment amount is refunded.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "REFUNDED",
        "type": "`\"refunded\"`",
        "description": "The order's payment amount is refunded.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "REQUIRES_ACTION",
        "type": "`\"requires_action\"`",
        "description": "The order's payment requires action.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "q",
    "type": "`string`",
    "description": "Search term to search orders' display ID, email, shipping address's first name, customer's first name, customer's last name, and customer's phone number.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "region_id",
    "type": "`string`",
    "description": "Region ID to filter orders by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "status",
    "type": "[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)[]",
    "description": "Statuses to filter orders by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "ARCHIVED",
        "type": "`\"archived\"`",
        "description": "The order is archived.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "CANCELED",
        "type": "`\"canceled\"`",
        "description": "The order is canceled.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "COMPLETED",
        "type": "`\"completed\"`",
        "description": "The order is completed, meaning that \nthe items have been fulfilled and the payment\nhas been captured.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "PENDING",
        "type": "`\"pending\"`",
        "description": "The order is pending.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "REQUIRES_ACTION",
        "type": "`\"requires_action\"`",
        "description": "The order requires action.",
        "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"/>
