giftCard - admin-graphql - QUERY

Version: 2024-01

Description:

Returns a gift card resource by ID.

Access Scopes

`read_gift_cards` access scope.

Arguments

• id: ID! - The ID of the GiftCard to return.

Returns

• balance: MoneyV2! The gift card's remaining balance.
• createdAt: DateTime! The date and time at which the gift card was created.
• customer: Customer The customer who will receive the gift card.
• disabledAt: DateTime The date and time at which the gift card was disabled.
• enabled: Boolean! Whether the gift card is enabled.
• expiresOn: Date The date at which the gift card will expire.
• id: ID! A globally-unique ID.
• initialValue: MoneyV2! The initial value of the gift card.
• lastCharacters: String! The final four characters of the gift card code.
• maskedCode: String! 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.

Examples

• Retrieves a single gift card

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-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"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query {\n    giftCard(id: \"gid://shopify/GiftCard/411106674\") {\n      balance {\n        amount\n        currencyCode\n      }\n    }\n  }\nQUERY;\n\n$response = $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}"
        

  input: null

  response: {
    "data": {
      "giftCard": {
        "balance": {
          "amount": "25.0",
          "currencyCode": "USD"
        }
      }
    }
  }