GiftCard - admin-graphql - OBJECT

Version: unstable

Description:

Represents an issued gift card.

Access Scopes

`read_gift_cards` access scope.

Fields

• 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.
• deactivatedAt: DateTime - The date and time at which the gift card was deactivated.
• 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.
• notify: Boolean! - Whether the customer and recipient will be notified when the gift card is issued.
• order: Order - The order associated with the gift card. This value is `null` if the gift card was issued manually.
• recipientAttributes: GiftCardRecipient - The recipient who will receive the gift card.
• templateSuffix: String - The theme template used to render the gift card online.
• updatedAt: DateTime! - The date and time at which the gift card was updated.

Connections

• transactions: GiftCardTransactionConnection

Related queries

• giftCard Returns a gift card resource by ID.
• giftCards Returns a list of gift cards.

Related mutations

• giftCardCreate Create a gift card.
• giftCardDeactivate Deactivate a gift card. A deactivated gift card cannot be used by a customer. A deactivated gift card cannot be re-enabled.
• giftCardSendNotificationToCustomer Send notification to the customer of a gift card.
• giftCardSendNotificationToRecipient Send notification to the recipient of a gift card.
• 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/unstable/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"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"gid://shopify/GiftCard/411106674\",\n  \"firstTransactions\" => 5,\n];\n\n$response = $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}"
        

  input: {
    "id": "gid://shopify/GiftCard/411106674",
    "firstTransactions": 5
  }

  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/unstable/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([\"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"
        }
      }
    }
  }