Choose a version:

giftCard

query

Requires read_gift_cards access scope.

Retrieves a GiftCard by its ID. Returns the gift card's balance, transaction history, Customer information, and whether it's enabled.

Additional fields include the initial value, expiration date, deactivation timestamp (if applicable), and the associated Order if the gift card was purchased by a customer through checkout. Gift cards that merchants create manually won't have an associated order.

Anchor to Arguments

Arguments

Anchor to idid •ID! required: The ID of the GiftCard to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to GiftCardGiftCard •GiftCard: A gift card that customers use as a payment method. Stores the initial value, current balance, and expiration date.

You can issue gift cards to a specific Customer or send them to a GiftCardRecipient with a personalized message. The card tracks its transaction history through GiftCardCreditTransaction and GiftCardDebitTransaction records. You can create and deactivate gift cards using the GiftCardCreate and GiftCardDeactivate mutations, respectively.

Note
After a gift card is deactivated, it can't be used for further purchases or re-enabled.

Was this section helpful?

Examples

Receive a list of all Gift Card Adjustments

Query

query GiftCardTransactionList($id: ID!, $firstTransactions: Int) {
  giftCard(id: $id) {
    id
    balance {
      amount
      currencyCode
    }
    transactions(first: $firstTransactions) {
      nodes {
        amount {
          amount
          currencyCode
        }
      }
    }
  }
}

Variables

{
  "id": "gid://shopify/GiftCard/411106674",
  "firstTransactions": 5
}

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 GiftCardTransactionList($id: ID!, $firstTransactions: Int) { giftCard(id: $id) { id balance { amount currencyCode } transactions(first: $firstTransactions) { nodes { amount { amount currencyCode } } } } }",
 "variables": {
    "id": "gid://shopify/GiftCard/411106674",
    "firstTransactions": 5
  }
}'

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 GiftCardTransactionList($id: ID!, $firstTransactions: Int) {
    giftCard(id: $id) {
      id
      balance {
        amount
        currencyCode
      }
      transactions(first: $firstTransactions) {
        nodes {
          amount {
            amount
            currencyCode
          }
        }
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/GiftCard/411106674",
        "firstTransactions": 5
    },
  },
  );
  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 GiftCardTransactionList($id: ID!, $firstTransactions: Int) {
    giftCard(id: $id) {
      id
      balance {
        amount
        currencyCode
      }
      transactions(first: $firstTransactions) {
        nodes {
          amount {
            amount
            currencyCode
          }
        }
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/GiftCard/411106674",
  "firstTransactions": 5
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query GiftCardTransactionList($id: ID!, $firstTransactions: Int) {
      giftCard(id: $id) {
        id
        balance {
          amount
          currencyCode
        }
        transactions(first: $firstTransactions) {
          nodes {
            amount {
              amount
              currencyCode
            }
          }
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/GiftCard/411106674",
        "firstTransactions": 5
    },
  },
});

Response

{
  "giftCard": {
    "id": "gid://shopify/GiftCard/411106674",
    "balance": {
      "amount": "25.0",
      "currencyCode": "USD"
    },
    "transactions": {
      "nodes": []
    }
  }
}

Retrieves a single gift card

Description

The following query takes a gift card ID, and returns the balance of the gift card.

Query

query {
  giftCard(id: "gid://shopify/GiftCard/411106674") {
    balance {
      amount
      currencyCode
    }
  }
}

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 { giftCard(id: \"gid://shopify/GiftCard/411106674\") { balance { amount currencyCode } } }"
}'

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 {
    giftCard(id: "gid://shopify/GiftCard/411106674") {
      balance {
        amount
        currencyCode
      }
    }
  }`,
  );
  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 {
    giftCard(id: "gid://shopify/GiftCard/411106674") {
      balance {
        amount
        currencyCode
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    giftCard(id: "gid://shopify/GiftCard/411106674") {
      balance {
        amount
        currencyCode
      }
    }
  }`,
});

Response

{
  "giftCard": {
    "balance": {
      "amount": "25.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 GiftCardTransactionList($id: ID!, $firstTransactions: Int) {

giftCard(id: $id) {

balance {

amount

currencyCode

}

transactions(first: $firstTransactions) {

nodes {

amount {

amount

currencyCode

}

}`,

{

variables: {

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

"firstTransactions": 5

);

const json = await response.json();

return json.data;

}

GQL

query GiftCardTransactionList($id: ID!, $firstTransactions: Int) {
  giftCard(id: $id) {
    id
    balance {
      amount
      currencyCode
    }
    transactions(first: $firstTransactions) {
      nodes {
        amount {
          amount
          currencyCode
        }
      }
    }
  }
}

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 GiftCardTransactionList($id: ID!, $firstTransactions: Int) { giftCard(id: $id) { id balance { amount currencyCode } transactions(first: $firstTransactions) { nodes { amount { amount currencyCode } } } } }",
 "variables": {
    "id": "gid://shopify/GiftCard/411106674",
    "firstTransactions": 5
  }
}'

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 GiftCardTransactionList($id: ID!, $firstTransactions: Int) {
    giftCard(id: $id) {
      id
      balance {
        amount
        currencyCode
      }
      transactions(first: $firstTransactions) {
        nodes {
          amount {
            amount
            currencyCode
          }
        }
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/GiftCard/411106674",
        "firstTransactions": 5
    },
  },
  );
  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 GiftCardTransactionList($id: ID!, $firstTransactions: Int) {
      giftCard(id: $id) {
        id
        balance {
          amount
          currencyCode
        }
        transactions(first: $firstTransactions) {
          nodes {
            amount {
              amount
              currencyCode
            }
          }
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/GiftCard/411106674",
        "firstTransactions": 5
    },
  },
});

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 GiftCardTransactionList($id: ID!, $firstTransactions: Int) {
    giftCard(id: $id) {
      id
      balance {
        amount
        currencyCode
      }
      transactions(first: $firstTransactions) {
        nodes {
          amount {
            amount
            currencyCode
          }
        }
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/GiftCard/411106674",
  "firstTransactions": 5
}

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

Input variables

JSON

{

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

"firstTransactions": 5

}

Response

JSON

{

"giftCard": {

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

"balance": {

"amount": "25.0",

"currencyCode": "USD"

"transactions": {

"nodes": []

}