Choose a version:

giftCardsCount

query

Requires read_gift_cards access scope.

Returns the total count of gift cards that have been issued by the shop. Use this for dashboard summaries or to understand the scale of a merchant's gift card program. The count includes all gift cards regardless of status (active, disabled, or fully redeemed). 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, including gift card codes.
Anchor to balance_status •string
Anchor to created_at •time
Anchor to customer_id •id
Anchor to expires_on •date
Anchor to id •id: Filter by id range.
Anchor to initial_value •string
Anchor to recipient_id •id
Anchor to source •string
Anchor to status •string

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

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

Get the total number of enabled gift cards that are issued for the shop

Description

The following query retrieves a count for the total number of enabled gift cards that are issued for the shop.

Query

query {
  giftCardsCount(query: "status:enabled") {
    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 { giftCardsCount(query: \"status:enabled\") { 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 {
    giftCardsCount(query: "status:enabled") {
      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 {
    giftCardsCount(query: "status:enabled") {
      count
    }
  }
QUERY

response = client.query(query: query)

Node.js

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

Shopify CLI

shopify app execute \
--query \
'query {
  giftCardsCount(query: "status:enabled") {
    count
  }
}'

Direct API Access

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

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

Response

{
  "giftCardsCount": {
    "count": 10
  }
}

Retrieves a count of gift cards

Description

The following query retrieves a count for the total number of all gift cards that are issued for the shop.

Query

query {
  giftCardsCount {
    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 { giftCardsCount { 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 {
    giftCardsCount {
      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 {
    giftCardsCount {
      count
    }
  }
QUERY

response = client.query(query: query)

Node.js

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

Shopify CLI

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

Direct API Access

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

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

Response

{
  "giftCardsCount": {
    "count": 11
  }
}

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 {

giftCardsCount(query: "status:enabled") {

count

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query {
  giftCardsCount(query: "status:enabled") {
    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 { giftCardsCount(query: \"status:enabled\") { 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 {
    giftCardsCount(query: "status:enabled") {
      count
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

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

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 {
    giftCardsCount(query: "status:enabled") {
      count
    }
  }
QUERY

response = client.query(query: query)

Shopify CLI

shopify app execute \
--query \
'query {
  giftCardsCount(query: "status:enabled") {
    count
  }
}'

Direct API Access

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

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

Response

JSON

{

"giftCardsCount": {

"count": 10

}