Choose a version:

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

GiftCard

•

GiftCard

Represents an issued gift card.

balance• MoneyV2! non-null: The gift card's remaining balance.
createdAt• DateTime! non-null: The date and time at which the gift card was created.
customer• Customer: The customer who will receive the gift card.
enabled• Boolean! non-null: Whether the gift card is enabled.
expiresOn• Date: The date at which the gift card will expire.
id• ID! non-null: A globally-unique ID.
initialValue• MoneyV2! non-null: The initial value of the gift card.
lastCharacters• String! non-null: The final four characters of the gift card code.
maskedCode• String! non-null: The gift card code. Everything but the final four characters is masked.
note• String: The note associated with the gift card, which isn't visible to the customer.
order• Order: The order associated with the gift card. This value is null if the gift card was issued manually.
disabledAt• DateTime Deprecated: The date and time at which the gift card was disabled. Use deactivatedAt instead.

Was this section helpful?

Retrieves a single gift card

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query {

giftCard(id: "gid://shopify/GiftCard/411106674") {

balance {

amount

currencyCode

}

}`,

);

const data = await response.json();

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

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-07/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 } } }"
}'

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

const response = await admin.graphql(
  `#graphql
  query {
    giftCard(id: "gid://shopify/GiftCard/411106674") {
      balance {
        amount
        currencyCode
      }
    }
  }`,
);

const data = await response.json();

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

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)

Response

JSON

{

"giftCard": {

"balance": {

"amount": "25.0",

"currencyCode": "USD"

}