giftCard

query

Requires read_gift_cards access scope.

Returns a gift card resource by ID.

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: Represents an issued gift card.

Was this section helpful?

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  query GiftCardTransactionList($id: ID!, $firstTransactions: Int) {
6    giftCard(id: $id) {
7      id
8      balance {
9        amount
10        currencyCode
11      }
12      transactions(first: $firstTransactions) {
13        nodes {
14          amount {
15            amount
16            currencyCode
17          }
18        }
19      }
20    }
21  }`,
22  {
23    variables: {
24      "id": "gid://shopify/GiftCard/411106674",
25      "firstTransactions": 5
26    },
27  },
28);
29
30const data = await response.json();
31

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

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 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 { 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 data = await response.json();

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
    },
  },
});

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

1{
2  "id": "gid://shopify/GiftCard/411106674",
3  "firstTransactions": 5
4}

Response

JSON

1{
2  "giftCard": {
3    "id": "gid://shopify/GiftCard/411106674",
4    "balance": {
5      "amount": "25.0",
6      "currencyCode": "USD"
7    },
8    "transactions": {
9      "nodes": []
10    }
11  }
12}