Choose a version:

discountNodesCount

query

Requires read_discounts access scope.

The total number of discounts for the shop. Limited to a maximum of 10000.

Arguments

query

•

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 combines_with • string: Filter by the Shopify Functions discount classes that the discount type can combine with.
Anchor to discount_class • string: Filter by the discount class.
Anchor to discount_type • string: Filter by the discount type.
Anchor to id • id: Filter by id range.
Anchor to method • string: Filter by the discount method.
Anchor to starts_at • time: Filter by the date and time, in the shop's timezone, when the discount becomes active and is available for customer use.
Anchor to status • string: Filter by the status of the discount.
Anchor to times_used • integer: Filter by the number of times the discount has been used. For example, if a "Buy 3, Get 1 Free" t-shirt discount is automatically applied in 200 transactions, then the discount has been used 200 times.

This value is updated asynchronously. As a result, it might be different than the actual usage count.
Anchor to title • string: Filter by the discount name that displays to merchants in the Shopify admin and to customers.
Anchor to type • string: Filter by the discount type.

savedSearchId

•

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

Count

•

Count

Details for count of elements.

count• Int! non-null: The count of elements.
precision• CountPrecision! non-null: The count's precision, or the exactness of the value.

Was this section helpful?

Retrieve the number of discounts used more than once
Retrieve the number of discounts used within a range
Retrieve the number of unused discounts
Retrieve the total number of discounts
Retrieves a count of all price rules

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query discountNodesCount($query: String!) {

discountNodesCount(query: $query) {

count

precision

}

}`,

{

variables: {

"query": "times_used:>1"

);

const data = await response.json();

query discountNodesCount($query: String!) {
  discountNodesCount(query: $query) {
    count
    precision
  }
}

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 discountNodesCount($query: String!) { discountNodesCount(query: $query) { count precision } }",
 "variables": {
    "query": "times_used:>1"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  query discountNodesCount($query: String!) {
    discountNodesCount(query: $query) {
      count
      precision
    }
  }`,
  {
    variables: {
      "query": "times_used:>1"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query discountNodesCount($query: String!) {
      discountNodesCount(query: $query) {
        count
        precision
      }
    }`,
    "variables": {
      "query": "times_used:>1"
    },
  },
});

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 discountNodesCount($query: String!) {
    discountNodesCount(query: $query) {
      count
      precision
    }
  }
QUERY

variables = {
  "query": "times_used:>1"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"query": "times_used:>1"

}

Response

JSON

{

"discountNodesCount": {

"count": 3,

"precision": "EXACT"

}