discountNodesCount - admin-graphql - QUERY

Version: 2024-10

Description:

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

Access Scopes

`read_discounts` access scope.

Arguments

query: String - A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | default | string | Filter by a case-insensitive search of multiple fields in a document. | | | - `query=Bob Norman` - `query=title:green hoodie` | | combines_with | string | Filter by the [Shopify Functions discount classes](https://shopify.dev/docs/apps/build/discounts#discount-classes) that the [discount type](https://shopify.dev/docs/api/admin-graphql/latest/queries/discountnodes#argument-query-filter-discount_type) can combine with. | - `order_discounts` - `product_discounts` - `shipping_discounts` | | - `combines_with:product_discounts` | | discount_class | string | Filter by the [discount class](https://shopify.dev/docs/apps/build/discounts#discount-classes). | - `order` - `product` - `shipping` | | - `discount_class:product` | | discount_type | string | Filter by the [discount type](https://help.shopify.com/manual/discounts/discount-types). | - `bogo` - `fixed_amount` - `free_shipping` - `percentage` | | - `type:fixed_amount` | | id | id | Filter by `id` range. | | | - `id:1234` - `id:>=1234` - `id:<=1234` | | method | string | Filter by the [discount method](https://shopify.dev/docs/apps/build/discounts#discount-methods). | - `automatic` - `code` | | - `method:code` | | 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. | | | - `starts_at:>'2020-10-21T23:39:20Z'` - `starts_at:<now` - `starts_at:<='2024'` | | status | string | Filter by the status of the discount. | - `active` - `expired` - `scheduled` | | - `status:scheduled` | | 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. | | | - `times_used:0` - `times_used:>150` - `times_used:>=200` | | title | string | Filter by the discount name that displays to merchants in the Shopify admin and to customers. | | | - `title:Black Friday Sale` | | type | string | Filter by the [discount type](https://help.shopify.com/manual/discounts/discount-types). | - `all` - `all_with_app` - `app` - `bxgy` - `fixed_amount` - `free_shipping` - `percentage` | | - `type:percentage` | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).
savedSearchId: ID - The ID of an existing saved search. The search’s query string is used as the query argument. Refer to the [`SavedSearch`](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch) object.

Returns

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

Examples

Retrieve the number of discounts used more than once

        Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query discountNodesCount($query: String!) { discountNodesCount(query: $query) { count precision } }\",\n \"variables\": {\n    \"query\": \"times_used:>1\"\n  }\n}'\n"
        Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query discountNodesCount($query: String!) {\n      discountNodesCount(query: $query) {\n        count\n        precision\n      }\n    }`,\n    \"variables\": {\n      \"query\": \"times_used:>1\"\n    },\n  },\n});\n"
        Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query discountNodesCount($query: String!) {\n    discountNodesCount(query: $query) {\n      count\n      precision\n    }\n  }\nQUERY\n\nvariables = {\n  \"query\": \"times_used:>1\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
        PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query discountNodesCount($query: String!) {\n    discountNodesCount(query: $query) {\n      count\n      precision\n    }\n  }\nQUERY;\n\n$variables = [\n  \"query\" => \"times_used:>1\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
        Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query discountNodesCount($query: String!) {\n    discountNodesCount(query: $query) {\n      count\n      precision\n    }\n  }`,\n  {\n    variables: {\n      \"query\": \"times_used:>1\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
        Graphql query: "query discountNodesCount($query: String!) {\n  discountNodesCount(query: $query) {\n    count\n    precision\n  }\n}"

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

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

Retrieve the number of discounts used within a range

        Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query discountNodesCount($query: String!) { discountNodesCount(query: $query) { count precision } }\",\n \"variables\": {\n    \"query\": \"times_used:>1 AND times_used:<4\"\n  }\n}'\n"
        Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query discountNodesCount($query: String!) {\n      discountNodesCount(query: $query) {\n        count\n        precision\n      }\n    }`,\n    \"variables\": {\n      \"query\": \"times_used:>1 AND times_used:<4\"\n    },\n  },\n});\n"
        Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query discountNodesCount($query: String!) {\n    discountNodesCount(query: $query) {\n      count\n      precision\n    }\n  }\nQUERY\n\nvariables = {\n  \"query\": \"times_used:>1 AND times_used:<4\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
        PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query discountNodesCount($query: String!) {\n    discountNodesCount(query: $query) {\n      count\n      precision\n    }\n  }\nQUERY;\n\n$variables = [\n  \"query\" => \"times_used:>1 AND times_used:<4\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
        Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query discountNodesCount($query: String!) {\n    discountNodesCount(query: $query) {\n      count\n      precision\n    }\n  }`,\n  {\n    variables: {\n      \"query\": \"times_used:>1 AND times_used:<4\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
        Graphql query: "query discountNodesCount($query: String!) {\n  discountNodesCount(query: $query) {\n    count\n    precision\n  }\n}"

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

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

Retrieve the number of unused discounts

        Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query discountNodesCount($query: String!) { discountNodesCount(query: $query) { count precision } }\",\n \"variables\": {\n    \"query\": \"times_used:0\"\n  }\n}'\n"
        Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query discountNodesCount($query: String!) {\n      discountNodesCount(query: $query) {\n        count\n        precision\n      }\n    }`,\n    \"variables\": {\n      \"query\": \"times_used:0\"\n    },\n  },\n});\n"
        Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query discountNodesCount($query: String!) {\n    discountNodesCount(query: $query) {\n      count\n      precision\n    }\n  }\nQUERY\n\nvariables = {\n  \"query\": \"times_used:0\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
        PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query discountNodesCount($query: String!) {\n    discountNodesCount(query: $query) {\n      count\n      precision\n    }\n  }\nQUERY;\n\n$variables = [\n  \"query\" => \"times_used:0\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
        Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query discountNodesCount($query: String!) {\n    discountNodesCount(query: $query) {\n      count\n      precision\n    }\n  }`,\n  {\n    variables: {\n      \"query\": \"times_used:0\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
        Graphql query: "query discountNodesCount($query: String!) {\n  discountNodesCount(query: $query) {\n    count\n    precision\n  }\n}"

input: {
  "query": "times_used:0"
}

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

Retrieve the total number of discounts

        Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query discountNodesCount { discountNodesCount { count precision } }\"\n}'\n"
        Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query discountNodesCount {\n    discountNodesCount {\n      count\n      precision\n    }\n  }`,\n});\n"
        Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query discountNodesCount {\n    discountNodesCount {\n      count\n      precision\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
        PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query discountNodesCount {\n    discountNodesCount {\n      count\n      precision\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
        Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query discountNodesCount {\n    discountNodesCount {\n      count\n      precision\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
        Graphql query: "query discountNodesCount {\n  discountNodesCount {\n    count\n    precision\n  }\n}"

input: null

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

Retrieves a count of all price rules

        Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query DiscountCount { discountNodesCount { count precision } }\"\n}'\n"
        Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query DiscountCount {\n    discountNodesCount {\n      count\n      precision\n    }\n  }`,\n});\n"
        Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query DiscountCount {\n    discountNodesCount {\n      count\n      precision\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
        PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query DiscountCount {\n    discountNodesCount {\n      count\n      precision\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
        Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query DiscountCount {\n    discountNodesCount {\n      count\n      precision\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
        Graphql query: "query DiscountCount {\n  discountNodesCount {\n    count\n    precision\n  }\n}"

input: null

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