# orders - admin-graphql - QUERY
Version: 2024-10

## Description
Returns a list of orders placed in the store.

### Access Scopes



## Arguments
* [after](/docs/api/admin-graphql/2024-10/scalars/String): String - The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* [before](/docs/api/admin-graphql/2024-10/scalars/String): String - The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* [first](/docs/api/admin-graphql/2024-10/scalars/Int): Int - The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* [last](/docs/api/admin-graphql/2024-10/scalars/Int): Int - The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* [query](/docs/api/admin-graphql/2024-10/scalars/String): String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
| ---- | ---- | ---- | ---- | ---- | ---- |
| default | string | Filter by a case-insensitive search of multiple fields in a document. | | | - `query=Bob Norman`<br/> - `query=title:green hoodie` |
| cart_token | string | Filter by the cart token's unique value, which references the cart that's associated with an order. | | | - `cart_token:abc123` |
| channel | string | Filter by the channel information [`handle`](https://shopify.dev/api/admin-graphql/latest/objects/ChannelInformation#field-channeldefinition) (`ChannelInformation.channelDefinition.handle`) field. | | | - `channel:web`<br/> - `channel:web,pos` |
| channel_id | id | Filter by the channel [`id`](https://shopify.dev/api/admin-graphql/latest/objects/Channel#field-id) field. | | | - `channel_id:123` |
| chargeback_status | string | Filter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial institution. | - `accepted`<br/> - `charge_refunded`<br/> - `lost`<br/> - `needs_response`<br/> - `under_review`<br/> - `won` | | - `chargeback_status:accepted` |
| checkout_token | string | Filter by the checkout token's unique value, which references the checkout that's associated with an order. | | | - `checkout_token:abc123` |
| confirmation_number | string | Filter by the randomly generated alpha-numeric identifier for an order that can be displayed to the customer instead of the sequential order name. This value isn't guaranteed to be unique. | | | - `confirmation_number:ABC123` |
| created_at | time | Filter by the date and time when the order was created in Shopify's system. | | | - `created_at:2020-10-21T23:39:20Z`<br/> - `created_at:<now`<br/> - `created_at:<=2024` |
| credit_card_last4 | string | Filter by the last four digits of the credit card that was used to pay for the order. | | | - `credit_card_last4:1234` |
| customer_id | id | Filter orders by the customer [`id`](https://shopify.dev/api/admin-graphql/latest/objects/Customer#field-id) field. | | | - `customer_id:123` |
| delivery_method | string | Filter by the delivery [`methodType`](https://shopify.dev/api/admin-graphql/2024-07/objects/DeliveryMethod#field-methodtype) field. | - `shipping`<br/> - `pick-up`<br/> - `retail`<br/> - `local`<br/> - `pickup-point`<br/> - `none` | | - `delivery_method:shipping` |
| discount_code | string | Filter by the case-insensitive discount code that was applied to the order at checkout. Maximum characters: 255. | | | - `discount_code:ABC123` |
| email | string | Filter by the email address that's associated with the order. | | | - `email:example@shopify.com` |
| financial_status | string | Filter by the order [`displayFinancialStatus`](https://shopify.dev/api/admin-graphql/latest/objects/Order#field-displayfinancialstatus) field. | - `paid`<br/> - `pending`<br/> - `authorized`<br/> - `partially_paid`<br/> - `partially_refunded`<br/> - `refunded`<br/> - `voided`<br/> - `expired` | | - `financial_status:authorized` |
| fraud_protection_level | string | Filter by the level of fraud protection that's applied to the order. | - `fully_protected`<br/> - `partially_protected`<br/> - `not_protected`<br/> - `pending`<br/> - `not_eligible`<br/> - `not_available` | | - `fraud_protection_level:fully_protected` |
| fulfillment_location_id | id | Filter by the fulfillment location [`id`](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment#field-location) (`Fulfillment.location.id`) field. | | | - `fulfillment_location_id:123` |
| fulfillment_status | string | Filter by the order's fulfillment status. | - `unfulfilled`<br/> - `fulfilled`<br/> - `partial`<br/> - `scheduled`<br/> - `on_hold`<br/> - `request_declined` | | - `fulfillment_status:fulfilled` |
| gateway | string | Filter by the order [`paymentGatewayNames`](https://shopify.dev/api/admin-graphql/latest/objects/Order#field-paymentgatewaynames) field. | | | - `gateway:shopify_payments` |
| id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` |
| location_id | id | Filter by the ID of the location that's associated with the order. | | | - `location_id:123` |
| name | string | Filter by the order [`name`](https://shopify.dev/api/admin-graphql/latest/objects/Order#field-name) field. | | | - `name:1001-A` |
| payment_id | string | Filter by the ID of the payment that's associated with the order. | | | - `payment_id:abc123` |
| payment_provider_id | id | Filter by the ID of the payment provider that's associated with the order. | | | - `payment_provider_id:123` |
| po_number | string | Filter by the order [`poNumber`](https://shopify.dev/api/admin-graphql/latest/objects/Order#field-ponumber) field. | | | - `po_number:P01001` |
| processed_at | time | Filter by the order [`processedAt`](https://shopify.dev/api/admin-graphql/latest/objects/Order#field-processedat) field. | | | - `processed_at:2021-01-01T00:00:00Z` |
| reference_location_id | id | Filter by the ID of a location that's associated with the order, such as locations from fulfillments, refunds, or the shop's primary location. | | | - `reference_location_id:123` |
| return_status | string | Filter by the order's return status. | - `open`<br/> - `requested`<br/> - `declined`<br/> - `canceled`<br/> - `closed` | | - `return_status:open` |
| risk_level | string | Filter by the order risk assessment [`riskLevel`](https://shopify.dev/api/admin-graphql/latest/objects/OrderRiskAssessment#field-risklevel) field. | - `high`<br/> - `medium`<br/> - `low`<br/> - `none`<br/> - `pending` | | - `risk_level:high` |
| sales_channel | string | Filter by the sales channel that the order is attributed to. | | | - `sales_channel: some_sales_channel` |
| sku | string | Filter by the product variant [`sku`](https://shopify.dev/api/admin-graphql/latest/objects/ProductVariant#field-sku) field. [Learn more about SKUs](https://help.shopify.com/manual/products/details/sku). | | | - `sku:ABC123` |
| source_identifier | string | Filter by the ID of the order placed on the originating platform, such as a unique POS or third-party identifier. This value doesn't correspond to the Shopify ID that's generated from a completed draft order. | | | - `source_identifier:1234-12-1000` |
| source_name | string | Filter by the name of the originating platform that's associated with the checkout for the order. | | | - `source_name:web`<br/> - `source_name:shopify_draft_order` |
| status | string | Filter by the order status. | - `open`<br/> - `closed`<br/> - `cancelled`<br/> - `not_closed` | | - `status:open` |
| subtotal_line_items_quantity | string |
| tag | string | Filter objects by the `tag` field. | | | - `tag:my_tag` |
| tag_not | string | Filter by objects that don’t have the specified tag. | | | - `tag_not:my_tag` |
| test | boolean | Filter by test orders. Test orders are made using the [Shopify Bogus Gateway](https://help.shopify.com/manual/checkout-settings/test-orders) or a payment provider with test mode enabled. | | | - `test:true` |
| updated_at | time | Filter by the date and time when the order was last updated in Shopify's system. | | | - `updated_at:2020-10-21T23:39:20Z`<br/> - `updated_at:<now`<br/> - `updated_at:<=2024` |
You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).

* [reverse](/docs/api/admin-graphql/2024-10/scalars/Boolean): Boolean - Reverse the order of the underlying list.
* [savedSearchId](/docs/api/admin-graphql/2024-10/scalars/ID): ID - The ID of a [saved search](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch#field-id).
The search’s query string is used as the query argument.
* [sortKey](/docs/api/admin-graphql/2024-10/enums/OrderSortKeys): OrderSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used in the search](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).


## Returns
* [edges](/docs/api/admin-graphql/2024-10/objects/OrderEdge): OrderEdge! The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
* [nodes](/docs/api/admin-graphql/2024-10/objects/Order): Order! A list of nodes that are contained in OrderEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
* [pageInfo](/docs/api/admin-graphql/2024-10/objects/PageInfo): PageInfo! An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page.


## Examples
### Get the first 10 orders updated after December 1, 2019
Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { orders(first: 10, query: \\\"updated_at:>2019-12-01\\\") { edges { node { id updatedAt } } } }\"\n}'\n"
Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    orders(first: 10, query: \"updated_at:>2019-12-01\") {\n      edges {\n        node {\n          id\n          updatedAt\n        }\n      }\n    }\n  }`,\n});\n"
Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query {\n    orders(first: 10, query: \"updated_at:>2019-12-01\") {\n      edges {\n        node {\n          id\n          updatedAt\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n" 
Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    orders(first: 10, query: \"updated_at:>2019-12-01\") {\n      edges {\n        node {\n          id\n          updatedAt\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
Graphql query: "query {\n  orders(first: 10, query: \"updated_at:>2019-12-01\") {\n    edges {\n      node {\n        id\n        updatedAt\n      }\n    }\n  }\n}"
#### Graphql Input
null
#### Graphql Response
{
  "data": {
    "orders": {
      "edges": [
        {
          "node": {
            "id": "gid://shopify/Order/158040885",
            "updatedAt": "2021-12-01T12:34:43Z"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Order/199007853",
            "updatedAt": "2021-12-01T12:34:43Z"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Order/212949620",
            "updatedAt": "2021-12-01T12:34:43Z"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Order/294238686",
            "updatedAt": "2021-12-01T12:34:43Z"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Order/316002265",
            "updatedAt": "2021-12-01T12:34:43Z"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Order/459506686",
            "updatedAt": "2021-12-01T12:34:43Z"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Order/634584900",
            "updatedAt": "2021-12-01T12:34:43Z"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Order/744797037",
            "updatedAt": "2021-12-01T12:34:43Z"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Order/1001810659",
            "updatedAt": "2021-12-01T12:34:43Z"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Order/1021030140",
            "updatedAt": "2021-12-01T12:34:43Z"
          }
        }
      ]
    }
  }
}

### Get the first 10 orders with authorized payments
Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { orders(first: 10, query: \\\"financial_status:authorized\\\") { edges { node { id displayFinancialStatus } } } }\"\n}'\n"
Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    orders(first: 10, query: \"financial_status:authorized\") {\n      edges {\n        node {\n          id\n          displayFinancialStatus\n        }\n      }\n    }\n  }`,\n});\n"
Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query {\n    orders(first: 10, query: \"financial_status:authorized\") {\n      edges {\n        node {\n          id\n          displayFinancialStatus\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n" 
Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    orders(first: 10, query: \"financial_status:authorized\") {\n      edges {\n        node {\n          id\n          displayFinancialStatus\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
Graphql query: "query {\n  orders(first: 10, query: \"financial_status:authorized\") {\n    edges {\n      node {\n        id\n        displayFinancialStatus\n      }\n    }\n  }\n}"
#### Graphql Input
null
#### Graphql Response
{
  "data": {
    "orders": {
      "edges": [
        {
          "node": {
            "id": "gid://shopify/Order/471861129",
            "displayFinancialStatus": "AUTHORIZED"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Order/527229289",
            "displayFinancialStatus": "AUTHORIZED"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Order/751082136",
            "displayFinancialStatus": "AUTHORIZED"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Order/431501862",
            "displayFinancialStatus": "AUTHORIZED"
          }
        }
      ]
    }
  }
}

### Retrieve a list of orders
Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { orders(first: 10) { edges { node { id } } } }\"\n}'\n"
Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    orders(first: 10) {\n      edges {\n        node {\n          id\n        }\n      }\n    }\n  }`,\n});\n"
Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query {\n    orders(first: 10) {\n      edges {\n        node {\n          id\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n" 
Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    orders(first: 10) {\n      edges {\n        node {\n          id\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
Graphql query: "query {\n  orders(first: 10) {\n    edges {\n      node {\n        id\n      }\n    }\n  }\n}"
#### Graphql Input
null
#### Graphql Response
{
  "data": {
    "orders": {
      "edges": [
        {
          "node": {
            "id": "gid://shopify/Order/126216516"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Order/148977776"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Order/235240302"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Order/357944854"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Order/404481575"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Order/409214363"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Order/471861129"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Order/480796189"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Order/527229289"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Order/556527638"
          }
        }
      ]
    }
  }
}