draftOrders

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 created_at • time
Anchor to customer_id • id
Anchor to id • id: Filter by id range.
Anchor to source • string
Anchor to status • string
Anchor to tag • string
Anchor to updated_at • time

reverse

•

BooleanDefault:false

Reverse the order of the underlying list.

savedSearchId

•

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

sortKey

•

DraftOrderSortKeysDefault:ID

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 • [DraftOrderEdge!]!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 • [DraftOrder!]!non-null: A list of nodes that are contained in DraftOrderEdge. 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?

Get the first 10 draft orders
Get the first 10 draft orders created after December 1, 2019
Get the first 10 draft orders with a status of 'OPEN'
Get the first draft order for a given customer
Retrieves a list of draft orders

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  query {
6    draftOrders(first: 10) {
7      edges {
8        node {
9          id
10        }
11      }
12    }
13  }`,
14);
15
16const data = await response.json();
17

query {
  draftOrders(first: 10) {
    edges {
      node {
        id
      }
    }
  }
}

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

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

const response = await admin.graphql(
  `#graphql
  query {
    draftOrders(first: 10) {
      edges {
        node {
          id
        }
      }
    }
  }`,
);

const data = await response.json();

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

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 {
    draftOrders(first: 10) {
      edges {
        node {
          id
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

1{
2  "draftOrders": {
3    "edges": [
4      {
5        "node": {
6          "id": "gid://shopify/DraftOrder/12873508"
7        }
8      },
9      {
10        "node": {
11          "id": "gid://shopify/DraftOrder/14492994"
12        }
13      },
14      {
15        "node": {
16          "id": "gid://shopify/DraftOrder/15964851"
17        }
18      },
19      {
20        "node": {
21          "id": "gid://shopify/DraftOrder/17011624"
22        }
23      },
24      {
25        "node": {
26          "id": "gid://shopify/DraftOrder/33942910"
27        }
28      },
29      {
30        "node": {
31          "id": "gid://shopify/DraftOrder/35687358"
32        }
33      },
34      {
35        "node": {
36          "id": "gid://shopify/DraftOrder/35831665"
37        }
38      },
39      {
40        "node": {
41          "id": "gid://shopify/DraftOrder/57615313"
42        }
43      },
44      {
45        "node": {
46          "id": "gid://shopify/DraftOrder/116136825"
47        }
48      },
49      {
50        "node": {
51          "id": "gid://shopify/DraftOrder/138565067"
52        }
53      }
54    ]
55  }
56}