giftCardsCount

query

Requires read_gift_cards access scope.

The total number of gift cards issued for the shop. Limited to a maximum of 10000.

Arguments

query

•

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: Searched fields: code.
Anchor to balance_status • string
Anchor to created_at • time
Anchor to expires_on • date
Anchor to id • id: Filter by id range.
Anchor to initial_value • string
Anchor to source • string
Anchor to status • string

savedSearchId

•

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?

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

Examples

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

const response = await admin.graphql(

`#graphql

query {

giftCardsCount(query: "status:enabled") {

count

}

}`,

);

const data = await response.json();

query {
  giftCardsCount(query: "status:enabled") {
    count
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { giftCardsCount(query: \"status:enabled\") { count } }"
}'

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

const response = await admin.graphql(
  `#graphql
  query {
    giftCardsCount(query: "status:enabled") {
      count
    }
  }`,
);

const data = await response.json();

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

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)

Response

JSON

{

"giftCardsCount": {

"count": 10

}