discountCodesCount - admin-graphql - QUERY

Version: 2024-04

Description:

The total number of discount codes for the shop.

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`<br/> - `query=title:green hoodie` | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | times_used | integer | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).

Returns

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

Examples

• Retrieve the number of discount codes used more than once

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query discountCodesCount($query: String!) { discountCodesCount(query: $query) { count } }\",\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 discountCodesCount($query: String!) {\n      discountCodesCount(query: $query) {\n        count\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 discountCodesCount($query: String!) {\n    discountCodesCount(query: $query) {\n      count\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 discountCodesCount($query: String!) {\n    discountCodesCount(query: $query) {\n      count\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 discountCodesCount($query: String!) {\n    discountCodesCount(query: $query) {\n      count\n    }\n  }`,\n  {\n    variables: {\n      \"query\": \"times_used:>1\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query discountCodesCount($query: String!) {\n  discountCodesCount(query: $query) {\n    count\n  }\n}"
        

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

  response: {
    "data": {
      "discountCodesCount": {
        "count": 3
      }
    }
  }

  Retrieve the number of discount codes used within a range

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query discountCodesCount($query: String!) { discountCodesCount(query: $query) { count } }\",\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 discountCodesCount($query: String!) {\n      discountCodesCount(query: $query) {\n        count\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 discountCodesCount($query: String!) {\n    discountCodesCount(query: $query) {\n      count\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 discountCodesCount($query: String!) {\n    discountCodesCount(query: $query) {\n      count\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 discountCodesCount($query: String!) {\n    discountCodesCount(query: $query) {\n      count\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 discountCodesCount($query: String!) {\n  discountCodesCount(query: $query) {\n    count\n  }\n}"
        

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

  response: {
    "data": {
      "discountCodesCount": {
        "count": 2
      }
    }
  }

  Retrieve the number of unused discount codes

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query discountCodesCount($query: String!) { discountCodesCount(query: $query) { count } }\",\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 discountCodesCount($query: String!) {\n      discountCodesCount(query: $query) {\n        count\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 discountCodesCount($query: String!) {\n    discountCodesCount(query: $query) {\n      count\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 discountCodesCount($query: String!) {\n    discountCodesCount(query: $query) {\n      count\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 discountCodesCount($query: String!) {\n    discountCodesCount(query: $query) {\n      count\n    }\n  }`,\n  {\n    variables: {\n      \"query\": \"times_used:0\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query discountCodesCount($query: String!) {\n  discountCodesCount(query: $query) {\n    count\n  }\n}"
        

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

  response: {
    "data": {
      "discountCodesCount": {
        "count": 25
      }
    }
  }

  Retrieve the total number of discount codes

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query discountCodesCount { discountCodesCount { count } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query discountCodesCount {\n    discountCodesCount {\n      count\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 discountCodesCount {\n    discountCodesCount {\n      count\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 discountCodesCount {\n    discountCodesCount {\n      count\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 discountCodesCount {\n    discountCodesCount {\n      count\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query discountCodesCount {\n  discountCodesCount {\n    count\n  }\n}"
        

  input: null

  response: {
    "data": {
      "discountCodesCount": {
        "count": 29
      }
    }
  }

  Retrieves a count of discount codes for a shop

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query DiscountRedeemCodeCount { discountCodesCount { count } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query DiscountRedeemCodeCount {\n    discountCodesCount {\n      count\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 DiscountRedeemCodeCount {\n    discountCodesCount {\n      count\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 DiscountRedeemCodeCount {\n    discountCodesCount {\n      count\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 DiscountRedeemCodeCount {\n    discountCodesCount {\n      count\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query DiscountRedeemCodeCount {\n  discountCodesCount {\n    count\n  }\n}"
        

  input: null

  response: {
    "data": {
      "discountCodesCount": {
        "count": 29
      }
    }
  }