Choose a version:

draftOrdersCount

query

Requires read_draft_orders access scope.

Returns the number of draft orders that match the query. Limited to a maximum of 10000 by default.

Arguments

limit

•IntDefault:10000

The upper bound on count value before returning a result. Use null to have no limit.

query

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

savedSearchId

•ID

The ID of an existing saved search. The search’s query string is used as the query argument. Refer to the SavedSearch object.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to CountCount •Count: Details for count of elements.

Was this section helpful?

Receive a count of all DraftOrders

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query draftOrdersCount {

draftOrdersCount {

count

}

}`,

);

const data = await response.json();

query draftOrdersCount {
  draftOrdersCount {
    count
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query draftOrdersCount { draftOrdersCount { count } }"
}'

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

const response = await admin.graphql(
  `#graphql
  query draftOrdersCount {
    draftOrdersCount {
      count
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query draftOrdersCount {
    draftOrdersCount {
      count
    }
  }`,
});

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 draftOrdersCount {
    draftOrdersCount {
      count
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"draftOrdersCount": {

"count": 4

}