Choose a version:

orders

query

Returns a list of orders placed in the store, including data such as order status, customer, and line item details. Use the orders query to build reports, analyze sales performance, or automate fulfillment workflows. The orders query supports pagination, sorting, and filtering.

Anchor to Arguments

OrderConnection arguments

•OrderConnection!

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to queryquery

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to cart_token •string: Filter by the cart token's unique value to track abandoned cart conversions or troubleshoot checkout issues. The token references the cart that's associated with an order.
Anchor to channel •string: Filter by the channel information handle (ChannelInformation.channelDefinition.handle) field.
Anchor to channel_id •id: Filter by the channel id field.
Anchor to 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.
Anchor to checkout_token •string: Filter by the checkout token's unique value to analyze conversion funnels or resolve payment issues. The checkout token's value references the checkout that's associated with an order.
Anchor to 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.
Anchor to created_at •time: Filter by the date and time when the order was created in Shopify's system.
Anchor to credit_card_last4 •string: Filter by the last four digits of the payment card that was used to pay for the order. This filter matches only the last four digits of the card for heightened security.
Anchor to customer_id •id: Filter orders by the customer id field.
Anchor to delivery_method •string: Filter by the delivery methodType field.
Anchor to discount_code •string: Filter by the case-insensitive discount code that was applied to the order at checkout. Limited to the first discount code used on an order. Maximum characters: 255.
Anchor to email •string: Filter by the email address that's associated with the order to provide customer support or analyze purchasing patterns.
Anchor to financial_status •string: Filter by the order displayFinancialStatus field.
Anchor to fraud_protection_level •string: Filter by the level of fraud protection that's applied to the order. Use this filter to manage risk or handle disputes.
Anchor to fulfillment_location_id •id: Filter by the fulfillment location id (Fulfillment.location.id) field.
Anchor to fulfillment_status •string: Filter by the displayFulfillmentStatus field to prioritize shipments or monitor order processing.
Anchor to gateway •string: Filter by the paymentGatewayNames field. Use this filter to find orders that were processed through specific payment providers like Shopify Payments, PayPal, or other custom payment gateways.
Anchor to id •id: Filter by id range.
Anchor to location_id •id: Filter by the location id that's associated with the order to view and manage orders for specific locations. For POS orders, locations must be defined in the Shopify admin under Settings > Locations. If no ID is provided, then the primary location of the shop is returned.
Anchor to metafields.{namespace}.{key} •mixed: Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.
Anchor to name •string: Filter by the order name field.
Anchor to payment_id •string: Filter by the payment ID that's associated with the order to reconcile financial records or troubleshoot payment issues.
Anchor to payment_provider_id •id: Filter by the ID of the payment provider that's associated with the order to manage payment methods or troubleshoot transactions.
Anchor to po_number •string: Filter by the order poNumber field.
Anchor to processed_at •time: Filter by the order processedAt field.
Anchor to 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.
Anchor to return_status •string: Filter by the order's returnStatus to monitor returns processing and track which orders have active returns.
Anchor to risk_level •string: Filter by the order risk assessment riskLevel field.
Anchor to sales_channel •string: Filter by the sales channel where the order was made to analyze performance or manage fulfillment processes.
Anchor to sku •string: Filter by the product variant sku field. Learn more about SKUs.
Anchor to 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.
Anchor to source_name •string: Filter by the platform where the order was placed to distinguish between web orders, POS sales, draft orders, or third-party channels. Use this filter to analyze sales performance across different ordering methods.
Anchor to status •string: Filter by the order's status to manage workflows or analyze the order lifecycle.
Anchor to subtotal_line_items_quantity •string: Filter by the total number of items across all line items in an order. This filter supports both exact values and ranges, and is useful for identifying bulk orders or analyzing purchase volume patterns.
Anchor to tag •string: Filter objects by the tag field.
Anchor to tag_not •string: Filter by objects that don’t have the specified tag.
Anchor to test •boolean: Filter by test orders. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled.
Anchor to updated_at •time: Filter by the date and time when the order was last updated in Shopify's system.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to sortKeysortKey

•OrderSortKeys

Default:PROCESSED_AT

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.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges •[OrderEdge!]! non-null: The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
Anchor to nodesnodes •[Order!]! non-null: 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.
Anchor to pageInfopageInfo •PageInfo! non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?

Examples

Retrieve a list of orders

Description

This query retrieves the first 10 [`orders`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) using [pagination](https://shopify.dev/docs/api/usage/pagination-graphql) and returns order IDs.

Query

query {
  orders(first: 10) {
    edges {
      cursor
      node {
        id
      }
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { orders(first: 10) { edges { cursor node { id } } pageInfo { hasNextPage hasPreviousPage startCursor endCursor } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    orders(first: 10) {
      edges {
        cursor
        node {
          id
        }
      }
      pageInfo {
        hasNextPage
        hasPreviousPage
        startCursor
        endCursor
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    orders(first: 10) {
      edges {
        cursor
        node {
          id
        }
      }
      pageInfo {
        hasNextPage
        hasPreviousPage
        startCursor
        endCursor
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    orders(first: 10) {
      edges {
        cursor
        node {
          id
        }
      }
      pageInfo {
        hasNextPage
        hasPreviousPage
        startCursor
        endCursor
      }
    }
  }`,
});

Response

{
  "orders": {
    "edges": [
      {
        "cursor": "eyJsYXN0X2lkIjoxMjYyMTY1MTYsImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9",
        "node": {
          "id": "gid://shopify/Order/126216516"
        }
      },
      {
        "cursor": "eyJsYXN0X2lkIjoxNDg5Nzc3NzYsImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9",
        "node": {
          "id": "gid://shopify/Order/148977776"
        }
      },
      {
        "cursor": "eyJsYXN0X2lkIjoyMzUyNDAzMDIsImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9",
        "node": {
          "id": "gid://shopify/Order/235240302"
        }
      },
      {
        "cursor": "eyJsYXN0X2lkIjozNTc5NDQ4NTQsImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9",
        "node": {
          "id": "gid://shopify/Order/357944854"
        }
      },
      {
        "cursor": "eyJsYXN0X2lkIjo0MDQ0ODE1NzUsImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9",
        "node": {
          "id": "gid://shopify/Order/404481575"
        }
      },
      {
        "cursor": "eyJsYXN0X2lkIjo0MDkyMTQzNjMsImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9",
        "node": {
          "id": "gid://shopify/Order/409214363"
        }
      },
      {
        "cursor": "eyJsYXN0X2lkIjo0NzE4NjExMjksImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9",
        "node": {
          "id": "gid://shopify/Order/471861129"
        }
      },
      {
        "cursor": "eyJsYXN0X2lkIjo0ODA3OTYxODksImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9",
        "node": {
          "id": "gid://shopify/Order/480796189"
        }
      },
      {
        "cursor": "eyJsYXN0X2lkIjo1MjcyMjkyODksImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9",
        "node": {
          "id": "gid://shopify/Order/527229289"
        }
      },
      {
        "cursor": "eyJsYXN0X2lkIjo1NTY1Mjc2MzgsImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9",
        "node": {
          "id": "gid://shopify/Order/556527638"
        }
      }
    ],
    "pageInfo": {
      "hasNextPage": true,
      "hasPreviousPage": false,
      "startCursor": "eyJsYXN0X2lkIjoxMjYyMTY1MTYsImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9",
      "endCursor": "eyJsYXN0X2lkIjo1NTY1Mjc2MzgsImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9"
    }
  }
}

Retrieve a list of orders using their IDs and GraphQL aliases

Description

This query demonstrates GraphQL aliases such as `order1` and `order2` to fetch multiple orders in a single query. Without aliases, requesting the same field twice would cause an error due to duplicate response keys.

Query

query {
  order1: order(id: "gid://shopify/Order/148977776") {
    name
  }
  order2: order(id: "gid://shopify/Order/1073459961") {
    name
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { order1: order(id: \"gid://shopify/Order/148977776\") { name } order2: order(id: \"gid://shopify/Order/1073459961\") { name } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    order1: order(id: "gid://shopify/Order/148977776") {
      name
    }
    order2: order(id: "gid://shopify/Order/1073459961") {
      name
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    order1: order(id: "gid://shopify/Order/148977776") {
      name
    }
    order2: order(id: "gid://shopify/Order/1073459961") {
      name
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    order1: order(id: "gid://shopify/Order/148977776") {
      name
    }
    order2: order(id: "gid://shopify/Order/1073459961") {
      name
    }
  }`,
});

Response

{
  "order1": {
    "name": "#1001"
  },
  "order2": {
    "name": "#1018"
  }
}

Retrieve specific order details

Description

This query retrieves the first five [`orders`](https://shopify.dev/api/admin-graphql/latest/objects/Order), including status information, financial data, and a list of [line items](https://shopify.dev/api/admin-graphql/latest/objects/LineItem). This query is useful for order processing, fulfillment, and financial reporting.

Query

query {
  orders(first: 5) {
    edges {
      node {
        id
        name
        createdAt
        displayFinancialStatus
        displayFulfillmentStatus
        totalPriceSet {
          shopMoney {
            amount
            currencyCode
          }
        }
        subtotalPriceSet {
          shopMoney {
            amount
            currencyCode
          }
        }
        email
        shippingAddress {
          address1
          city
          provinceCode
          zip
        }
        lineItems(first: 5) {
          edges {
            node {
              name
              quantity
              sku
              variant {
                id
                title
              }
            }
          }
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { orders(first: 5) { edges { node { id name createdAt displayFinancialStatus displayFulfillmentStatus totalPriceSet { shopMoney { amount currencyCode } } subtotalPriceSet { shopMoney { amount currencyCode } } email shippingAddress { address1 city provinceCode zip } lineItems(first: 5) { edges { node { name quantity sku variant { id title } } } } } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    orders(first: 5) {
      edges {
        node {
          id
          name
          createdAt
          displayFinancialStatus
          displayFulfillmentStatus
          totalPriceSet {
            shopMoney {
              amount
              currencyCode
            }
          }
          subtotalPriceSet {
            shopMoney {
              amount
              currencyCode
            }
          }
          email
          shippingAddress {
            address1
            city
            provinceCode
            zip
          }
          lineItems(first: 5) {
            edges {
              node {
                name
                quantity
                sku
                variant {
                  id
                  title
                }
              }
            }
          }
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    orders(first: 5) {
      edges {
        node {
          id
          name
          createdAt
          displayFinancialStatus
          displayFulfillmentStatus
          totalPriceSet {
            shopMoney {
              amount
              currencyCode
            }
          }
          subtotalPriceSet {
            shopMoney {
              amount
              currencyCode
            }
          }
          email
          shippingAddress {
            address1
            city
            provinceCode
            zip
          }
          lineItems(first: 5) {
            edges {
              node {
                name
                quantity
                sku
                variant {
                  id
                  title
                }
              }
            }
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    orders(first: 5) {
      edges {
        node {
          id
          name
          createdAt
          displayFinancialStatus
          displayFulfillmentStatus
          totalPriceSet {
            shopMoney {
              amount
              currencyCode
            }
          }
          subtotalPriceSet {
            shopMoney {
              amount
              currencyCode
            }
          }
          email
          shippingAddress {
            address1
            city
            provinceCode
            zip
          }
          lineItems(first: 5) {
            edges {
              node {
                name
                quantity
                sku
                variant {
                  id
                  title
                }
              }
            }
          }
        }
      }
    }
  }`,
});

Response

{
  "orders": {
    "edges": [
      {
        "node": {
          "id": "gid://shopify/Order/158040885",
          "name": "#2000",
          "createdAt": "2024-01-01T00:00:00Z",
          "displayFinancialStatus": "PAID",
          "displayFulfillmentStatus": "UNFULFILLED",
          "totalPriceSet": {
            "shopMoney": {
              "amount": "2000.0",
              "currencyCode": "CAD"
            }
          },
          "subtotalPriceSet": {
            "shopMoney": {
              "amount": "2000.0",
              "currencyCode": "CAD"
            }
          },
          "email": "bob@example.com",
          "shippingAddress": null,
          "lineItems": {
            "edges": [
              {
                "node": {
                  "name": "Draft - 151cm",
                  "quantity": 10,
                  "sku": "draft-151",
                  "variant": {
                    "id": "gid://shopify/ProductVariant/168923715",
                    "title": "151cm"
                  }
                }
              }
            ]
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/Order/199007853",
          "name": "#2006",
          "createdAt": "2024-01-01T00:00:00Z",
          "displayFinancialStatus": "PAID",
          "displayFulfillmentStatus": "UNFULFILLED",
          "totalPriceSet": {
            "shopMoney": {
              "amount": "2000.0",
              "currencyCode": "CAD"
            }
          },
          "subtotalPriceSet": {
            "shopMoney": {
              "amount": "2000.0",
              "currencyCode": "CAD"
            }
          },
          "email": "bob@example.com",
          "shippingAddress": null,
          "lineItems": {
            "edges": []
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/Order/212949620",
          "name": "#2002",
          "createdAt": "2024-01-01T00:00:00Z",
          "displayFinancialStatus": "PAID",
          "displayFulfillmentStatus": "UNFULFILLED",
          "totalPriceSet": {
            "shopMoney": {
              "amount": "2000.0",
              "currencyCode": "CAD"
            }
          },
          "subtotalPriceSet": {
            "shopMoney": {
              "amount": "2000.0",
              "currencyCode": "CAD"
            }
          },
          "email": "bob@example.com",
          "shippingAddress": null,
          "lineItems": {
            "edges": []
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/Order/294238686",
          "name": "#2009",
          "createdAt": "2024-01-01T00:00:00Z",
          "displayFinancialStatus": "PAID",
          "displayFulfillmentStatus": "UNFULFILLED",
          "totalPriceSet": {
            "shopMoney": {
              "amount": "2000.0",
              "currencyCode": "CAD"
            }
          },
          "subtotalPriceSet": {
            "shopMoney": {
              "amount": "2000.0",
              "currencyCode": "CAD"
            }
          },
          "email": "bob@example.com",
          "shippingAddress": null,
          "lineItems": {
            "edges": []
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/Order/316002265",
          "name": "#2003",
          "createdAt": "2024-01-01T00:00:00Z",
          "displayFinancialStatus": "PAID",
          "displayFulfillmentStatus": "UNFULFILLED",
          "totalPriceSet": {
            "shopMoney": {
              "amount": "2000.0",
              "currencyCode": "CAD"
            }
          },
          "subtotalPriceSet": {
            "shopMoney": {
              "amount": "2000.0",
              "currencyCode": "CAD"
            }
          },
          "email": "bob@example.com",
          "shippingAddress": null,
          "lineItems": {
            "edges": []
          }
        }
      }
    ]
  }
}

Retrieve the first 10 orders updated after December 1, 2019

Description

This query retrieves the first 10 [`orders`](https://shopify.dev/api/admin-graphql/latest/objects/Order) updated after December 1, 2019. The example shows how to use the [`updated_at`](https://shopify.dev/docs/api/admin-graphql/latest/queries/orders#argument-query-filter-updated_at) parameter to determine the orders that were updated after the specified date. Refer to [pagination](https://shopify.dev/api/usage/pagination-graphql) for best practices on handling larger result sets.

Query

query {
  orders(first: 10, query: "updated_at:>2019-12-01") {
    edges {
      node {
        id
        updatedAt
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { orders(first: 10, query: \"updated_at:>2019-12-01\") { edges { node { id updatedAt } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    orders(first: 10, query: "updated_at:>2019-12-01") {
      edges {
        node {
          id
          updatedAt
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    orders(first: 10, query: "updated_at:>2019-12-01") {
      edges {
        node {
          id
          updatedAt
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    orders(first: 10, query: "updated_at:>2019-12-01") {
      edges {
        node {
          id
          updatedAt
        }
      }
    }
  }`,
});

Response

{
  "orders": {
    "edges": [
      {
        "node": {
          "id": "gid://shopify/Order/158040885",
          "updatedAt": "2024-01-01T12:34:43Z"
        }
      },
      {
        "node": {
          "id": "gid://shopify/Order/199007853",
          "updatedAt": "2024-01-01T12:34:43Z"
        }
      },
      {
        "node": {
          "id": "gid://shopify/Order/212949620",
          "updatedAt": "2024-01-01T12:34:43Z"
        }
      },
      {
        "node": {
          "id": "gid://shopify/Order/294238686",
          "updatedAt": "2024-01-01T12:34:43Z"
        }
      },
      {
        "node": {
          "id": "gid://shopify/Order/316002265",
          "updatedAt": "2024-01-01T12:34:43Z"
        }
      },
      {
        "node": {
          "id": "gid://shopify/Order/459506686",
          "updatedAt": "2024-01-01T12:34:43Z"
        }
      },
      {
        "node": {
          "id": "gid://shopify/Order/634584900",
          "updatedAt": "2024-01-01T12:34:43Z"
        }
      },
      {
        "node": {
          "id": "gid://shopify/Order/744797037",
          "updatedAt": "2024-01-01T12:34:43Z"
        }
      },
      {
        "node": {
          "id": "gid://shopify/Order/1001810659",
          "updatedAt": "2024-01-01T12:34:43Z"
        }
      },
      {
        "node": {
          "id": "gid://shopify/Order/1021030140",
          "updatedAt": "2024-01-01T12:34:43Z"
        }
      }
    ]
  }
}

Retrieve the first 10 orders with authorized payments

Description

This query retrieves the first 10 [orders](https://shopify.dev/api/admin-graphql/latest/objects/Order) with authorized payments. For individual payment verification, refer to the [`orderPaymentStatus`](https://shopify.dev/api/admin-graphql/latest/queries/orderPaymentStatus) query.

Query

query {
  orders(first: 10, query: "financial_status:authorized") {
    edges {
      node {
        id
        displayFinancialStatus
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { orders(first: 10, query: \"financial_status:authorized\") { edges { node { id displayFinancialStatus } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    orders(first: 10, query: "financial_status:authorized") {
      edges {
        node {
          id
          displayFinancialStatus
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    orders(first: 10, query: "financial_status:authorized") {
      edges {
        node {
          id
          displayFinancialStatus
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    orders(first: 10, query: "financial_status:authorized") {
      edges {
        node {
          id
          displayFinancialStatus
        }
      }
    }
  }`,
});

Response

{
  "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"
        }
      }
    ]
  }
}

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query {

orders(first: 10) {

edges {

cursor

node {

}

pageInfo {

hasNextPage

hasPreviousPage

startCursor

endCursor

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query {
  orders(first: 10) {
    edges {
      cursor
      node {
        id
      }
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { orders(first: 10) { edges { cursor node { id } } pageInfo { hasNextPage hasPreviousPage startCursor endCursor } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    orders(first: 10) {
      edges {
        cursor
        node {
          id
        }
      }
      pageInfo {
        hasNextPage
        hasPreviousPage
        startCursor
        endCursor
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    orders(first: 10) {
      edges {
        cursor
        node {
          id
        }
      }
      pageInfo {
        hasNextPage
        hasPreviousPage
        startCursor
        endCursor
      }
    }
  }`,
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    orders(first: 10) {
      edges {
        cursor
        node {
          id
        }
      }
      pageInfo {
        hasNextPage
        hasPreviousPage
        startCursor
        endCursor
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"orders": {

"edges": [

{

"cursor": "eyJsYXN0X2lkIjoxMjYyMTY1MTYsImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9",

"node": {

"id": "gid://shopify/Order/126216516"

}

{

"cursor": "eyJsYXN0X2lkIjoxNDg5Nzc3NzYsImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9",

"node": {

"id": "gid://shopify/Order/148977776"

}

{

"cursor": "eyJsYXN0X2lkIjoyMzUyNDAzMDIsImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9",

"node": {

"id": "gid://shopify/Order/235240302"

}

{

"cursor": "eyJsYXN0X2lkIjozNTc5NDQ4NTQsImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9",

"node": {

"id": "gid://shopify/Order/357944854"

}

{

"cursor": "eyJsYXN0X2lkIjo0MDQ0ODE1NzUsImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9",

"node": {

"id": "gid://shopify/Order/404481575"

}

{

"cursor": "eyJsYXN0X2lkIjo0MDkyMTQzNjMsImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9",

"node": {

"id": "gid://shopify/Order/409214363"

}

{

"cursor": "eyJsYXN0X2lkIjo0NzE4NjExMjksImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9",

"node": {

"id": "gid://shopify/Order/471861129"

}

{

"cursor": "eyJsYXN0X2lkIjo0ODA3OTYxODksImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9",

"node": {

"id": "gid://shopify/Order/480796189"

}

{

"cursor": "eyJsYXN0X2lkIjo1MjcyMjkyODksImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9",

"node": {

"id": "gid://shopify/Order/527229289"

}

{

"cursor": "eyJsYXN0X2lkIjo1NTY1Mjc2MzgsImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9",

"node": {

"id": "gid://shopify/Order/556527638"

}

"pageInfo": {

"hasNextPage": true,

"hasPreviousPage": false,

"startCursor": "eyJsYXN0X2lkIjoxMjYyMTY1MTYsImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9",

"endCursor": "eyJsYXN0X2lkIjo1NTY1Mjc2MzgsImxhc3RfdmFsdWUiOiIyMDA1LTA3LTMxIDE1OjU3OjExLjAwMDAwMCJ9"

}