# GiftCard - admin-graphql - OBJECT Version: 2024-04 ## Description Represents an issued gift card. ### Access Scopes `read_gift_cards` access scope. ## Fields * [balance](/docs/api/admin-graphql/2024-04/objects/MoneyV2): MoneyV2! - The gift card's remaining balance. * [createdAt](/docs/api/admin-graphql/2024-04/scalars/DateTime): DateTime! - The date and time at which the gift card was created. * [customer](/docs/api/admin-graphql/2024-04/objects/Customer): Customer - The customer who will receive the gift card. * [disabledAt](/docs/api/admin-graphql/2024-04/scalars/DateTime): DateTime - The date and time at which the gift card was disabled. * [enabled](/docs/api/admin-graphql/2024-04/scalars/Boolean): Boolean! - Whether the gift card is enabled. * [expiresOn](/docs/api/admin-graphql/2024-04/scalars/Date): Date - The date at which the gift card will expire. * [id](/docs/api/admin-graphql/2024-04/scalars/ID): ID! - A globally-unique ID. * [initialValue](/docs/api/admin-graphql/2024-04/objects/MoneyV2): MoneyV2! - The initial value of the gift card. * [lastCharacters](/docs/api/admin-graphql/2024-04/scalars/String): String! - The final four characters of the gift card code. * [maskedCode](/docs/api/admin-graphql/2024-04/scalars/String): String! - The gift card code. Everything but the final four characters is masked. * [note](/docs/api/admin-graphql/2024-04/scalars/String): String - The note associated with the gift card, which isn't visible to the customer. * [order](/docs/api/admin-graphql/2024-04/objects/Order): Order - The order associated with the gift card. This value is `null` if the gift card was issued manually. ## Connections ## Related queries * [giftCard](/docs/api/admin-graphql/2024-04/queries/giftCard) Returns a gift card resource by ID. * [giftCards](/docs/api/admin-graphql/2024-04/queries/giftCards) Returns a list of gift cards. ## Related mutations * [giftCardCreate](/docs/api/admin-graphql/2024-04/mutations/giftCardCreate) Create a gift card. * [giftCardDisable](/docs/api/admin-graphql/2024-04/mutations/giftCardDisable) Disable a gift card. A disabled gift card cannot be used by a customer. A disabled gift card cannot be re-enabled. * [giftCardUpdate](/docs/api/admin-graphql/2024-04/mutations/giftCardUpdate) Update a gift card. ## Related Unions ## Examples ### Retrieves a single gift card Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { giftCard(id: \\\"gid://shopify/GiftCard/411106674\\\") { balance { amount currencyCode } } }\"\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: `query {\n giftCard(id: \"gid://shopify/GiftCard/411106674\") {\n balance {\n amount\n currencyCode\n }\n }\n }`,\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n query {\n giftCard(id: \"gid://shopify/GiftCard/411106674\") {\n balance {\n amount\n currencyCode\n }\n }\n }\nQUERY\n\nresponse = client.query(query: query)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query {\n giftCard(id: \"gid://shopify/GiftCard/411106674\") {\n balance {\n amount\n currencyCode\n }\n }\n }`,\n);\n\nconst data = await response.json();\n" Graphql query: "query {\n giftCard(id: \"gid://shopify/GiftCard/411106674\") {\n balance {\n amount\n currencyCode\n }\n }\n}" #### Graphql Input null #### Graphql Response { "data": { "giftCard": { "balance": { "amount": "25.0", "currencyCode": "USD" } } } }