# giftCard - admin-graphql - QUERY Version: 2024-10 ## Description Returns a gift card resource by ID. ### Access Scopes `read_gift_cards` access scope. ## Arguments * [id](/docs/api/admin-graphql/2024-10/scalars/ID): ID! - The ID of the GiftCard to return. ## Returns * [balance](/docs/api/admin-graphql/2024-10/objects/MoneyV2): MoneyV2! The gift card's remaining balance. * [createdAt](/docs/api/admin-graphql/2024-10/scalars/DateTime): DateTime! The date and time at which the gift card was created. * [customer](/docs/api/admin-graphql/2024-10/objects/Customer): Customer The customer who will receive the gift card. * [deactivatedAt](/docs/api/admin-graphql/2024-10/scalars/DateTime): DateTime The date and time at which the gift card was deactivated. * [enabled](/docs/api/admin-graphql/2024-10/scalars/Boolean): Boolean! Whether the gift card is enabled. * [expiresOn](/docs/api/admin-graphql/2024-10/scalars/Date): Date The date at which the gift card will expire. * [id](/docs/api/admin-graphql/2024-10/scalars/ID): ID! A globally-unique ID. * [initialValue](/docs/api/admin-graphql/2024-10/objects/MoneyV2): MoneyV2! The initial value of the gift card. * [lastCharacters](/docs/api/admin-graphql/2024-10/scalars/String): String! The final four characters of the gift card code. * [maskedCode](/docs/api/admin-graphql/2024-10/scalars/String): String! The gift card code. Everything but the final four characters is masked. * [note](/docs/api/admin-graphql/2024-10/scalars/String): String The note associated with the gift card, which isn't visible to the customer. * [order](/docs/api/admin-graphql/2024-10/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-graphql/2024-10/objects/GiftCardRecipient): GiftCardRecipient The recipient who will receive the gift card. * [templateSuffix](/docs/api/admin-graphql/2024-10/scalars/String): String The theme template used to render the gift card online. * [updatedAt](/docs/api/admin-graphql/2024-10/scalars/DateTime): DateTime! The date and time at which the gift card was updated. ## Examples ### Receive a list of all Gift Card Adjustments Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/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/2024-10/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" } } } }