Choose a version:

giftCards

query

Requires read_gift_cards access scope.

Returns a paginated list of GiftCard objects issued for the shop.

You can filter gift cards by attributes such as status, last characters of the code, balance status, and other values using the query parameter. You can also apply SavedSearch objects to filter results.

Anchor to Arguments

GiftCardConnection arguments

•GiftCardConnection!

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to lastlast

•Int

The last n elements from the paginated list.

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 expires_on •date
Anchor to id •id: Filter by id range.
Anchor to initial_value •string
Anchor to source •string
Anchor to status •string

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to sortKeysortKey

•GiftCardSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges •[GiftCardEdge!]! non-null: The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
Anchor to nodesnodes •[GiftCard!]! non-null: A list of nodes that are contained in GiftCardEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
Anchor to pageInfopageInfo •PageInfo! non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?

Examples

Get the first 5 enabled gift cards

Description

The following query retrieves the first five enabled gift cards for a shop, and returns the ID and enabled status of each gift card.

Query

query {
  giftCards(first: 5, query: "status:enabled") {
    edges {
      node {
        id
        enabled
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { giftCards(first: 5, query: \"status:enabled\") { edges { node { id enabled } } } }"
}'

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 {
    giftCards(first: 5, query: "status:enabled") {
      edges {
        node {
          id
          enabled
        }
      }
    }
  }`,
  );
  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 {
    giftCards(first: 5, query: "status:enabled") {
      edges {
        node {
          id
          enabled
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    giftCards(first: 5, query: "status:enabled") {
      edges {
        node {
          id
          enabled
        }
      }
    }
  }`,
});

Response

{
  "giftCards": {
    "edges": [
      {
        "node": {
          "id": "gid://shopify/GiftCard/63396415",
          "enabled": true
        }
      },
      {
        "node": {
          "id": "gid://shopify/GiftCard/292935194",
          "enabled": true
        }
      },
      {
        "node": {
          "id": "gid://shopify/GiftCard/411106674",
          "enabled": true
        }
      },
      {
        "node": {
          "id": "gid://shopify/GiftCard/566141102",
          "enabled": true
        }
      },
      {
        "node": {
          "id": "gid://shopify/GiftCard/636946744",
          "enabled": true
        }
      }
    ]
  }
}

Get up to 5 gift cards with the last characters "1234"

Description

The following query retrieves up to five gift cards with the last characters "1234" for a shop, and returns the ID and last characters of each gift card.

Query

query {
  giftCards(first: 5, query: "1234") {
    edges {
      node {
        id
        lastCharacters
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { giftCards(first: 5, query: \"1234\") { edges { node { id lastCharacters } } } }"
}'

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 {
    giftCards(first: 5, query: "1234") {
      edges {
        node {
          id
          lastCharacters
        }
      }
    }
  }`,
  );
  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 {
    giftCards(first: 5, query: "1234") {
      edges {
        node {
          id
          lastCharacters
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    giftCards(first: 5, query: "1234") {
      edges {
        node {
          id
          lastCharacters
        }
      }
    }
  }`,
});

Response

{
  "giftCards": {
    "edges": [
      {
        "node": {
          "id": "gid://shopify/GiftCard/411106674",
          "lastCharacters": "1234"
        }
      }
    ]
  }
}

Retrieves a list of gift cards

Description

The following query retrieves the first ten gift cards for a shop, and returns the ID of each gift card.

Query

query {
  giftCards(first: 10) {
    edges {
      node {
        id
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { giftCards(first: 10) { edges { node { id } } } }"
}'

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 {
    giftCards(first: 10) {
      edges {
        node {
          id
        }
      }
    }
  }`,
  );
  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 {
    giftCards(first: 10) {
      edges {
        node {
          id
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    giftCards(first: 10) {
      edges {
        node {
          id
        }
      }
    }
  }`,
});

Response

{
  "giftCards": {
    "edges": [
      {
        "node": {
          "id": "gid://shopify/GiftCard/63396415"
        }
      },
      {
        "node": {
          "id": "gid://shopify/GiftCard/83783397"
        }
      },
      {
        "node": {
          "id": "gid://shopify/GiftCard/292935194"
        }
      },
      {
        "node": {
          "id": "gid://shopify/GiftCard/411106674"
        }
      },
      {
        "node": {
          "id": "gid://shopify/GiftCard/566141102"
        }
      },
      {
        "node": {
          "id": "gid://shopify/GiftCard/636946744"
        }
      },
      {
        "node": {
          "id": "gid://shopify/GiftCard/638517611"
        }
      },
      {
        "node": {
          "id": "gid://shopify/GiftCard/665558842"
        }
      },
      {
        "node": {
          "id": "gid://shopify/GiftCard/746346263"
        }
      },
      {
        "node": {
          "id": "gid://shopify/GiftCard/842921201"
        }
      }
    ]
  }
}

Searches for gift cards

Query

query GiftCardList($first: Int, $query: String) {
  giftCards(first: $first, query: $query) {
    edges {
      node {
        id
        balance {
          amount
          currencyCode
        }
      }
    }
  }
}

Variables

{
  "first": 5,
  "query": "status:enabled"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query GiftCardList($first: Int, $query: String) { giftCards(first: $first, query: $query) { edges { node { id balance { amount currencyCode } } } } }",
 "variables": {
    "first": 5,
    "query": "status:enabled"
  }
}'

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 GiftCardList($first: Int, $query: String) {
    giftCards(first: $first, query: $query) {
      edges {
        node {
          id
          balance {
            amount
            currencyCode
          }
        }
      }
    }
  }`,
  {
    variables: {
        "first": 5,
        "query": "status:enabled"
    },
  },
  );
  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 GiftCardList($first: Int, $query: String) {
    giftCards(first: $first, query: $query) {
      edges {
        node {
          id
          balance {
            amount
            currencyCode
          }
        }
      }
    }
  }
QUERY

variables = {
  "first": 5,
  "query": "status:enabled"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query GiftCardList($first: Int, $query: String) {
      giftCards(first: $first, query: $query) {
        edges {
          node {
            id
            balance {
              amount
              currencyCode
            }
          }
        }
      }
    }`,
    "variables": {
        "first": 5,
        "query": "status:enabled"
    },
  },
});

Response

{
  "giftCards": {
    "edges": [
      {
        "node": {
          "id": "gid://shopify/GiftCard/63396415",
          "balance": {
            "amount": "10.0",
            "currencyCode": "USD"
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/GiftCard/292935194",
          "balance": {
            "amount": "75.0",
            "currencyCode": "EUR"
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/GiftCard/411106674",
          "balance": {
            "amount": "25.0",
            "currencyCode": "USD"
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/GiftCard/566141102",
          "balance": {
            "amount": "0.23",
            "currencyCode": "USD"
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/GiftCard/636946744",
          "balance": {
            "amount": "75.0",
            "currencyCode": "USD"
          }
        }
      }
    ]
  }
}

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 {

giftCards(first: 5, query: "status:enabled") {

edges {

node {

enabled

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query {
  giftCards(first: 5, query: "status:enabled") {
    edges {
      node {
        id
        enabled
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { giftCards(first: 5, query: \"status:enabled\") { edges { node { id enabled } } } }"
}'

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 {
    giftCards(first: 5, query: "status:enabled") {
      edges {
        node {
          id
          enabled
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    giftCards(first: 5, query: "status:enabled") {
      edges {
        node {
          id
          enabled
        }
      }
    }
  }`,
});

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 {
    giftCards(first: 5, query: "status:enabled") {
      edges {
        node {
          id
          enabled
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"giftCards": {

"edges": [

{

"node": {

"id": "gid://shopify/GiftCard/63396415",

"enabled": true

}

{

"node": {

"id": "gid://shopify/GiftCard/292935194",

"enabled": true

}

{

"node": {

"id": "gid://shopify/GiftCard/411106674",

"enabled": true

}

{

"node": {

"id": "gid://shopify/GiftCard/566141102",

"enabled": true

}

{

"node": {

"id": "gid://shopify/GiftCard/636946744",

"enabled": true

}

]

}