Choose a version:

discountNodesCount

query

Requires read_discounts access scope.

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

Anchor to Arguments

Arguments

Anchor to limitlimit

•Int

Default:10000

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

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 code •string: Filter by the discount code. Not supported for bulk discounts.
Anchor to combines_with •string: Filter by the Shopify Functions discount classes that the discount type can combine with.
Anchor to created_at •time: Filter by the date and time, in the shop's timezone, when the discount was created.
Anchor to discount_class •string: Filter by the discount class.
Anchor to discount_type •string: Filter by the discount type.
Anchor to ends_at •time: Filter by the date and time, in the shop's timezone, when the discount ends.
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.
Anchor to updated_at •time: Filter by the date and time, in the shop's timezone, when the discount was last updated.

Anchor to savedSearchIdsavedSearchId

•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?

Examples

Retrieve the number of discounts used more than once

Description

Returns the number of discounts that were used more than once.

Query

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

Variables

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

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-07/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"
  }
}'

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

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

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

Node.js

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"
    },
  },
});

Response

{
  "discountNodesCount": {
    "count": 3,
    "precision": "EXACT"
  }
}

Retrieve the number of discounts used within a range

Description

Returns the number of discounts that were used more than onceand less than four times.

Query

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

Variables

{
  "query": "times_used:>1 AND times_used:<4"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-07/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 AND times_used:<4"
  }
}'

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

variables = {
  "query": "times_used:>1 AND times_used:<4"
}

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

Node.js

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 AND times_used:<4"
    },
  },
});

Response

{
  "discountNodesCount": {
    "count": 2,
    "precision": "EXACT"
  }
}

Retrieve the number of unused discounts

Description

Returns the number of discounts that were never used.

Query

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

Variables

{
  "query": "times_used:0"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-07/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:0"
  }
}'

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

variables = {
  "query": "times_used:0"
}

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

Node.js

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:0"
    },
  },
});

Response

{
  "discountNodesCount": {
    "count": 37,
    "precision": "EXACT"
  }
}

Retrieve the total number of discounts

Description

Returns the total number of discounts.

Query

query discountNodesCount {
  discountNodesCount {
    count
    precision
  }
}

cURL

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

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 discountNodesCount {
    discountNodesCount {
      count
      precision
    }
  }`,
  );
  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 discountNodesCount {
    discountNodesCount {
      count
      precision
    }
  }
QUERY

response = client.query(query: query)

Node.js

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

Response

{
  "discountNodesCount": {
    "count": 41,
    "precision": "EXACT"
  }
}

Retrieves a count of all price rules

Query

query DiscountCount {
  discountNodesCount {
    count
    precision
  }
}

cURL

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

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 DiscountCount {
    discountNodesCount {
      count
      precision
    }
  }`,
  );
  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 DiscountCount {
    discountNodesCount {
      count
      precision
    }
  }
QUERY

response = client.query(query: query)

Node.js

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

Response

{
  "discountNodesCount": {
    "count": 41,
    "precision": "EXACT"
  }
}

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

discountNodesCount(query: $query) {

count

precision

}

}`,

{

variables: {

"query": "times_used:>1"

);

const json = await response.json();

return json.data;

}

GQL

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

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-07/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"
  }
}'

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 discountNodesCount($query: String!) {
    discountNodesCount(query: $query) {
      count
      precision
    }
  }`,
  {
    variables: {
        "query": "times_used:>1"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

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"
    },
  },
});

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 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"

}