Choose a version:

discountCodesCount

query

Requires read_discounts access scope.

The total number of discount codes 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.

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
id id Filter by id range. - id:1234
- id:>=1234
- 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).

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to CountCount

•Count

A numeric count with precision information indicating whether the count is exact or an estimate.

Anchor to countcount

•Int!

non-null

The count of elements.

Anchor to precisionprecision

•CountPrecision!

non-null

The count's precision, or the exactness of the value.

Was this section helpful?

Examples

Retrieve the number of discount codes used more than once

Description

Returns the number of discount codes that were used more than once.

Query

query discountCodesCount($query: String!) {
  discountCodesCount(query: $query) {
    count
  }
}

Variables

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

cURL

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

Shopify CLI

shopify app execute \
--query \
'query discountCodesCount($query: String!) {
  discountCodesCount(query: $query) {
    count
  }
}' \
--variables \
'{
  "query": "times_used:>1"
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query discountCodesCount($query: String!) {
        discountCodesCount(query: $query) {
          count
        }
      }
    `,
    variables: {
        "query": "times_used:>1"
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "discountCodesCount": {
    "count": 3
  }
}

Retrieve the number of discount codes used within a range

Description

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

Query

query discountCodesCount($query: String!) {
  discountCodesCount(query: $query) {
    count
  }
}

Variables

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

cURL

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

Shopify CLI

shopify app execute \
--query \
'query discountCodesCount($query: String!) {
  discountCodesCount(query: $query) {
    count
  }
}' \
--variables \
'{
  "query": "times_used:>1 AND times_used:<4"
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query discountCodesCount($query: String!) {
        discountCodesCount(query: $query) {
          count
        }
      }
    `,
    variables: {
        "query": "times_used:>1 AND times_used:<4"
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "discountCodesCount": {
    "count": 2
  }
}

Retrieve the number of unused discount codes

Description

Returns the number of discount codes that were never used.

Query

query discountCodesCount($query: String!) {
  discountCodesCount(query: $query) {
    count
  }
}

Variables

{
  "query": "times_used:0"
}

cURL

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

Shopify CLI

shopify app execute \
--query \
'query discountCodesCount($query: String!) {
  discountCodesCount(query: $query) {
    count
  }
}' \
--variables \
'{
  "query": "times_used:0"
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query discountCodesCount($query: String!) {
        discountCodesCount(query: $query) {
          count
        }
      }
    `,
    variables: {
        "query": "times_used:0"
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "discountCodesCount": {
    "count": 25
  }
}

Retrieve the total number of discount codes

Description

Returns the total number of discount codes.

Query

query discountCodesCount {
  discountCodesCount {
    count
  }
}

cURL

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 discountCodesCount { discountCodesCount { count } }"
}'

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

response = client.query(query: query)

Node.js

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

Shopify CLI

shopify app execute \
--query \
'query discountCodesCount {
  discountCodesCount {
    count
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query discountCodesCount {
        discountCodesCount {
          count
        }
      }
    `,
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "discountCodesCount": {
    "count": 29
  }
}

Retrieves a count of discount codes for a shop

Query

query DiscountRedeemCodeCount {
  discountCodesCount {
    count
  }
}

cURL

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 DiscountRedeemCodeCount { discountCodesCount { count } }"
}'

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

response = client.query(query: query)

Node.js

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

Shopify CLI

shopify app execute \
--query \
'query DiscountRedeemCodeCount {
  discountCodesCount {
    count
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query DiscountRedeemCodeCount {
        discountCodesCount {
          count
        }
      }
    `,
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "discountCodesCount": {
    "count": 29
  }
}

Examples

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

query discountCodesCount($query: String!) {

discountCodesCount(query: $query) {

count

}

}`,

{

variables: {

"query": "times_used:>1"

);

const json = await response.json();

return json.data;

}

GQL

query discountCodesCount($query: String!) {
  discountCodesCount(query: $query) {
    count
  }
}

cURL

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 discountCodesCount($query: String!) { discountCodesCount(query: $query) { count } }",
 "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 discountCodesCount($query: String!) {
    discountCodesCount(query: $query) {
      count
    }
  }`,
  {
    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 discountCodesCount($query: String!) {
      discountCodesCount(query: $query) {
        count
      }
    }`,
    "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 discountCodesCount($query: String!) {
    discountCodesCount(query: $query) {
      count
    }
  }
QUERY

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

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

Shopify CLI

shopify app execute \
--query \
'query discountCodesCount($query: String!) {
  discountCodesCount(query: $query) {
    count
  }
}' \
--variables \
'{
  "query": "times_used:>1"
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query discountCodesCount($query: String!) {
        discountCodesCount(query: $query) {
          count
        }
      }
    `,
    variables: {
        "query": "times_used:>1"
    },
  }),
});

const { data } = await response.json();
console.log(data);

Input variables

JSON

{

"query": "times_used:>1"

}

Response

JSON

{

"discountCodesCount": {

"count": 3

}

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `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).