data-src=../../../../includes/commerce-only.md

giftCardAccount query

The giftCardAccount query returns information for a specific gift card.

Syntax

giftCardAccount(code: String!): GiftCardAccount

Reference

The giftCardAccount reference provides detailed information about the types and fields defined in this query.

• Adobe Commerce as a Cloud Service

• On-Premises/Cloud

Example usage

The following example returns information about the 01PNC9L76H4H gift card code.

Request:

query {
  giftCardAccount(input: {gift_card_code: "01PNC9L76H4H"}){
    code
    balance {
      currency
      value
    }
    expiration_date
  }
}

Response:

{
  "data": {
    "giftCardAccount": {
      "code": "01PNC9L76H4H",
      "balance": {
        "currency": "USD",
        "value": 25
      },
      "expiration_date": null
    }
  }
}

Errors