# GiftCard - admin - OBJECT Version: 2025-01 ## Description Represents an issued gift card. ### Access Scopes `read_gift_cards` access scope. ## Fields * [balance](/docs/api/admin/2025-01/objects/MoneyV2): MoneyV2! - The gift card's remaining balance. * [createdAt](/docs/api/admin/2025-01/scalars/DateTime): DateTime! - The date and time at which the gift card was created. * [customer](/docs/api/admin/2025-01/objects/Customer): Customer - The customer who will receive the gift card. * [deactivatedAt](/docs/api/admin/2025-01/scalars/DateTime): DateTime - The date and time at which the gift card was deactivated. * [enabled](/docs/api/admin/2025-01/scalars/Boolean): Boolean! - Whether the gift card is enabled. * [expiresOn](/docs/api/admin/2025-01/scalars/Date): Date - The date at which the gift card will expire. * [id](/docs/api/admin/2025-01/scalars/ID): ID! - A globally-unique ID. * [initialValue](/docs/api/admin/2025-01/objects/MoneyV2): MoneyV2! - The initial value of the gift card. * [lastCharacters](/docs/api/admin/2025-01/scalars/String): String! - The final four characters of the gift card code. * [maskedCode](/docs/api/admin/2025-01/scalars/String): String! - The gift card code. Everything but the final four characters is masked. * [note](/docs/api/admin/2025-01/scalars/String): String - The note associated with the gift card, which isn't visible to the customer. * [order](/docs/api/admin/2025-01/objects/Order): Order - The order associated with the gift card. This value is `null` if the gift card was issued manually. * [recipientAttributes](/docs/api/admin/2025-01/objects/GiftCardRecipient): GiftCardRecipient - The recipient who will receive the gift card. * [templateSuffix](/docs/api/admin/2025-01/scalars/String): String - The theme template used to render the gift card online. * [updatedAt](/docs/api/admin/2025-01/scalars/DateTime): DateTime! - The date and time at which the gift card was updated. ## Connections * [transactions](/docs/api/admin/2025-01/connections/GiftCardTransactionConnection): GiftCardTransactionConnection ## Related queries * [giftCard](/docs/api/admin/2025-01/queries/giftCard) Returns a gift card resource by ID. * [giftCards](/docs/api/admin/2025-01/queries/giftCards) Returns a list of gift cards. ## Related mutations * [giftCardCreate](/docs/api/admin/2025-01/mutations/giftCardCreate) Create a gift card. * [giftCardDeactivate](/docs/api/admin/2025-01/mutations/giftCardDeactivate) Deactivate a gift card. A deactivated gift card cannot be used by a customer. A deactivated gift card cannot be re-enabled. * [giftCardSendNotificationToCustomer](/docs/api/admin/2025-01/mutations/giftCardSendNotificationToCustomer) Send notification to the customer of a gift card. * [giftCardSendNotificationToRecipient](/docs/api/admin/2025-01/mutations/giftCardSendNotificationToRecipient) Send notification to the recipient of a gift card. * [giftCardUpdate](/docs/api/admin/2025-01/mutations/giftCardUpdate) Update a gift card. ## Related Unions ## Examples ### Receive a list of all Gift Card Adjustments Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query GiftCardTransactionList($id: ID!, $firstTransactions: Int) { giftCard(id: $id) { id balance { amount currencyCode } transactions(first: $firstTransactions) { nodes { amount { amount currencyCode } } } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/GiftCard/411106674\",\n \"firstTransactions\": 5\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `query GiftCardTransactionList($id: ID!, $firstTransactions: Int) {\n giftCard(id: $id) {\n id\n balance {\n amount\n currencyCode\n }\n transactions(first: $firstTransactions) {\n nodes {\n amount {\n amount\n currencyCode\n }\n }\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/GiftCard/411106674\",\n \"firstTransactions\": 5\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 GiftCardTransactionList($id: ID!, $firstTransactions: Int) {\n giftCard(id: $id) {\n id\n balance {\n amount\n currencyCode\n }\n transactions(first: $firstTransactions) {\n nodes {\n amount {\n amount\n currencyCode\n }\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/GiftCard/411106674\",\n \"firstTransactions\": 5\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query GiftCardTransactionList($id: ID!, $firstTransactions: Int) {\n giftCard(id: $id) {\n id\n balance {\n amount\n currencyCode\n }\n transactions(first: $firstTransactions) {\n nodes {\n amount {\n amount\n currencyCode\n }\n }\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/GiftCard/411106674\",\n \"firstTransactions\": 5\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "query GiftCardTransactionList($id: ID!, $firstTransactions: Int) {\n giftCard(id: $id) {\n id\n balance {\n amount\n currencyCode\n }\n transactions(first: $firstTransactions) {\n nodes {\n amount {\n amount\n currencyCode\n }\n }\n }\n }\n}" #### Graphql Input { "id": "gid://shopify/GiftCard/411106674", "firstTransactions": 5 } #### Graphql Response { "data": { "giftCard": { "id": "gid://shopify/GiftCard/411106674", "balance": { "amount": "25.0", "currencyCode": "USD" }, "transactions": { "nodes": [] } } } } ### Retrieves a single gift card Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/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" } } } }