GiftCardProductQuery (Magento GraphQL data models and query builders 9.1.0-magento242ee API)

java.lang.Object
- com.shopify.graphql.support.AbstractQuery<GiftCardProductQuery>
- - com.adobe.cq.commerce.magento.graphql.GiftCardProductQuery

```
public class GiftCardProductQuery
extends AbstractQuery<GiftCardProductQuery>
```
GiftCardProduct defines properties of a gift card, including the minimum and maximum values and an array that contains the current and past values on the specific gift card

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class GiftCardProductQuery.ReviewsArguments

static interface GiftCardProductQuery.ReviewsArgumentsDefinition

Nested Classes
Modifier and Type	Class and Description
`class`	`GiftCardProductQuery.ReviewsArguments`
`static interface`	`GiftCardProductQuery.ReviewsArgumentsDefinition`

Field Summary
- Fields inherited from class com.shopify.graphql.support.AbstractQuery
  _queryBuilder, ALIAS_SUFFIX_SEPARATOR, CUSTOM_FIELD_LABEL

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`GiftCardProductQuery`	`addCustomizableProductInterfaceFragmentReference(Fragment<CustomizableProductInterfaceQuery> fragment)` Adds a `CustomizableProductInterfaceQuery` fragment reference at the current position of the query.
`GiftCardProductQuery`	`addFragmentReference(Fragment<GiftCardProductQuery> fragment)` Adds a `GiftCardProductQuery` fragment reference at the current position of the query.
`GiftCardProductQuery`	`addPhysicalProductInterfaceFragmentReference(Fragment<PhysicalProductInterfaceQuery> fragment)` Adds a `PhysicalProductInterfaceQuery` fragment reference at the current position of the query.
`GiftCardProductQuery`	`addProductInterfaceFragmentReference(Fragment<ProductInterfaceQuery> fragment)` Adds a `ProductInterfaceQuery` fragment reference at the current position of the query.
`GiftCardProductQuery`	`allowMessage()` Indicates whether the customer can provide a message to accompany the gift card.
`GiftCardProductQuery`	`allowOpenAmount()` Indicates whether customers have the ability to set the value of the gift card.
`GiftCardProductQuery`	`attributeSetId()` Deprecated. The field should not be used on the storefront.
`GiftCardProductQuery`	`canonicalUrl()` Relative canonical URL.
`GiftCardProductQuery`	`categories(CategoryInterfaceQueryDefinition queryDef)` The categories assigned to a product.
`GiftCardProductQuery`	`color()`
`GiftCardProductQuery`	`countryOfManufacture()` The product's country of origin.
`GiftCardProductQuery`	`createdAt()` Deprecated. The field should not be used on the storefront.
`static Fragment<GiftCardProductQuery>`	`createFragment(String name, GiftCardProductQueryDefinition queryDef)` Creates a GraphQL "named" fragment with the specified query type definition.
`GiftCardProductQuery`	`crosssellProducts(ProductInterfaceQueryDefinition queryDef)` Crosssell Products
`GiftCardProductQuery`	`description(ComplexTextValueQueryDefinition queryDef)` Detailed information about the product.
`GiftCardProductQuery`	`giftcardAmounts(GiftCardAmountsQueryDefinition queryDef)` An array that contains information about the values and ID of a gift card.
`GiftCardProductQuery`	`giftCardOptions(CustomizableOptionInterfaceQueryDefinition queryDef)` An array of giftcard options.
`GiftCardProductQuery`	`giftcardType()` Either VIRTUAL, PHYSICAL, or COMBINED.
`GiftCardProductQuery`	`giftMessageAvailable()` Indicates whether a gift message is available.
`GiftCardProductQuery`	`id()` Deprecated. Use the `uid` field instead.
`GiftCardProductQuery`	`image(ProductImageQueryDefinition queryDef)` The relative path to the main image on the product page.
`GiftCardProductQuery`	`isRedeemable()` Indicates whether the customer can redeem the value on the card for cash.
`GiftCardProductQuery`	`isReturnable()` Indicates whether the product can be returned
`GiftCardProductQuery`	`lifetime()` The number of days after purchase until the gift card expires.
`GiftCardProductQuery`	`manufacturer()` A number representing the product's manufacturer.
`GiftCardProductQuery`	`mediaGallery(MediaGalleryInterfaceQueryDefinition queryDef)` An array of Media Gallery objects.
`GiftCardProductQuery`	`mediaGalleryEntries(MediaGalleryEntryQueryDefinition queryDef)` Deprecated. Use product's `media_gallery` instead
`GiftCardProductQuery`	`messageMaxLength()` Indicates whether the customer can provide a message to accompany the gift card.
`GiftCardProductQuery`	`metaDescription()` A brief overview of the product for search results listings, maximum 255 characters.
`GiftCardProductQuery`	`metaKeyword()` A comma-separated list of keywords that are visible only to search engines.
`GiftCardProductQuery`	`metaTitle()` A string that is displayed in the title bar and tab of the browser and in search results lists.
`GiftCardProductQuery`	`name()` The product name.
`GiftCardProductQuery`	`newFromDate()` Deprecated. The field should not be used on the storefront.
`GiftCardProductQuery`	`newToDate()` Deprecated. The field should not be used on the storefront.
`GiftCardProductQuery`	`onlyXLeftInStock()` Product stock only x left count
`GiftCardProductQuery`	`openAmountMax()` The minimum acceptable value of an open amount gift card.
`GiftCardProductQuery`	`openAmountMin()` The minimum acceptable value of an open amount gift card.
`GiftCardProductQuery`	`options(CustomizableOptionInterfaceQueryDefinition queryDef)` An array of options for a customizable product.
`GiftCardProductQuery`	`optionsContainer()` If the product has multiple options, determines where they appear on the product page.
`GiftCardProductQuery`	`price(ProductPricesQueryDefinition queryDef)` Deprecated. Use price_range for product price information.
`GiftCardProductQuery`	`priceRange(PriceRangeQueryDefinition queryDef)` A PriceRange object, indicating the range of prices for the product
`GiftCardProductQuery`	`priceTiers(TierPriceQueryDefinition queryDef)` An array of TierPrice objects.
`GiftCardProductQuery`	`productLinks(ProductLinksInterfaceQueryDefinition queryDef)` An array of ProductLinks objects.
`GiftCardProductQuery`	`ratingSummary()` The average of all the ratings given to the product.
`GiftCardProductQuery`	`relatedProducts(ProductInterfaceQueryDefinition queryDef)` Related Products
`GiftCardProductQuery`	`reviewCount()` The total count of all the reviews given to the product.
`GiftCardProductQuery`	`reviews(GiftCardProductQuery.ReviewsArgumentsDefinition argsDef, ProductReviewsQueryDefinition queryDef)` The list of products reviews.
`GiftCardProductQuery`	`reviews(ProductReviewsQueryDefinition queryDef)` The list of products reviews.
`GiftCardProductQuery`	`shortDescription(ComplexTextValueQueryDefinition queryDef)` A short description of the product.
`GiftCardProductQuery`	`sku()` A number or code assigned to a product to identify the product, options, price, and manufacturer.
`GiftCardProductQuery`	`smallImage(ProductImageQueryDefinition queryDef)` The relative path to the small image, which is used on catalog pages.
`GiftCardProductQuery`	`specialFromDate()` Deprecated. The field should not be used on the storefront.
`GiftCardProductQuery`	`specialPrice()` The discounted price of the product.
`GiftCardProductQuery`	`specialToDate()` The end date that a product has a special price.
`GiftCardProductQuery`	`staged()`
`GiftCardProductQuery`	`stockStatus()` Stock status of the product
`GiftCardProductQuery`	`swatchImage()` The file name of a swatch image
`GiftCardProductQuery`	`thumbnail(ProductImageQueryDefinition queryDef)` The relative path to the product's thumbnail image.
`GiftCardProductQuery`	`tierPrice()` Deprecated. Use price_tiers for product tier price information.
`GiftCardProductQuery`	`tierPrices(ProductTierPricesQueryDefinition queryDef)` Deprecated. Use price_tiers for product tier price information.
`GiftCardProductQuery`	`typeId()` Deprecated. Use __typename instead.
`GiftCardProductQuery`	`uid()` The unique ID for a `ProductInterface` object.
`GiftCardProductQuery`	`updatedAt()` Deprecated. The field should not be used on the storefront.
`GiftCardProductQuery`	`upsellProducts(ProductInterfaceQueryDefinition queryDef)` Upsell Products
`GiftCardProductQuery`	`urlKey()` The part of the URL that identifies the product
`GiftCardProductQuery`	`urlPath()` Deprecated. Use product's `canonical_url` or url rewrites instead
`GiftCardProductQuery`	`urlRewrites(UrlRewriteQueryDefinition queryDef)` URL rewrites list
`GiftCardProductQuery`	`urlSuffix()` The part of the product URL that is appended after the url key
`GiftCardProductQuery`	`websites(WebsiteQueryDefinition queryDef)` Deprecated. The field should not be used on the storefront.
`GiftCardProductQuery`	`weight()` The weight of the item, in units defined by the store.

Methods inherited from class com.shopify.graphql.support.AbstractQuery
addCustomObjectField, addCustomSimpleField, appendQuotedString, startField, startInlineFragment, withAlias

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - allowMessage
```
public GiftCardProductQuery allowMessage()
```
    Indicates whether the customer can provide a message to accompany the gift card.
  - allowOpenAmount
```
public GiftCardProductQuery allowOpenAmount()
```
    Indicates whether customers have the ability to set the value of the gift card.
  - attributeSetId
```
@Deprecated
public GiftCardProductQuery attributeSetId()
```
    Deprecated. The field should not be used on the storefront.
    
    The attribute set assigned to the product.
  - canonicalUrl
```
public GiftCardProductQuery canonicalUrl()
```
    Relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled
  - categories
```
public GiftCardProductQuery categories(CategoryInterfaceQueryDefinition queryDef)
```
    The categories assigned to a product.
  - color
```
public GiftCardProductQuery color()
```
  - countryOfManufacture
```
public GiftCardProductQuery countryOfManufacture()
```
    The product's country of origin.
  - createdAt
```
@Deprecated
public GiftCardProductQuery createdAt()
```
    Deprecated. The field should not be used on the storefront.
    
    Timestamp indicating when the product was created.
  - crosssellProducts
```
public GiftCardProductQuery crosssellProducts(ProductInterfaceQueryDefinition queryDef)
```
    Crosssell Products
  - description
```
public GiftCardProductQuery description(ComplexTextValueQueryDefinition queryDef)
```
    Detailed information about the product. The value can include simple HTML tags.
  - giftCardOptions
```
public GiftCardProductQuery giftCardOptions(CustomizableOptionInterfaceQueryDefinition queryDef)
```
    An array of giftcard options.
  - giftMessageAvailable
```
public GiftCardProductQuery giftMessageAvailable()
```
    Indicates whether a gift message is available.
  - giftcardAmounts
```
public GiftCardProductQuery giftcardAmounts(GiftCardAmountsQueryDefinition queryDef)
```
    An array that contains information about the values and ID of a gift card.
  - giftcardType
```
public GiftCardProductQuery giftcardType()
```
    Either VIRTUAL, PHYSICAL, or COMBINED.
  - id
```
@Deprecated
public GiftCardProductQuery id()
```
    Deprecated. Use the `uid` field instead.
    
    The ID number assigned to the product.
  - image
```
public GiftCardProductQuery image(ProductImageQueryDefinition queryDef)
```
    The relative path to the main image on the product page.
  - isRedeemable
```
public GiftCardProductQuery isRedeemable()
```
    Indicates whether the customer can redeem the value on the card for cash.
  - isReturnable
```
public GiftCardProductQuery isReturnable()
```
    Indicates whether the product can be returned
  - lifetime
```
public GiftCardProductQuery lifetime()
```
    The number of days after purchase until the gift card expires. A null value means there is no limit.
  - manufacturer
```
public GiftCardProductQuery manufacturer()
```
    A number representing the product's manufacturer.
  - mediaGallery
```
public GiftCardProductQuery mediaGallery(MediaGalleryInterfaceQueryDefinition queryDef)
```
    An array of Media Gallery objects.
  - mediaGalleryEntries
```
@Deprecated
public GiftCardProductQuery mediaGalleryEntries(MediaGalleryEntryQueryDefinition queryDef)
```
    Deprecated. Use product's `media_gallery` instead
    
    An array of MediaGalleryEntry objects.
  - messageMaxLength
```
public GiftCardProductQuery messageMaxLength()
```
    Indicates whether the customer can provide a message to accompany the gift card.
  - metaDescription
```
public GiftCardProductQuery metaDescription()
```
    A brief overview of the product for search results listings, maximum 255 characters.
  - metaKeyword
```
public GiftCardProductQuery metaKeyword()
```
    A comma-separated list of keywords that are visible only to search engines.
  - metaTitle
```
public GiftCardProductQuery metaTitle()
```
    A string that is displayed in the title bar and tab of the browser and in search results lists.
  - name
```
public GiftCardProductQuery name()
```
    The product name. Customers use this name to identify the product.
  - newFromDate
```
@Deprecated
public GiftCardProductQuery newFromDate()
```
    Deprecated. The field should not be used on the storefront.
    
    The beginning date for new product listings, and determines if the product is featured as a new product.
  - newToDate
```
@Deprecated
public GiftCardProductQuery newToDate()
```
    Deprecated. The field should not be used on the storefront.
    
    The end date for new product listings.
  - onlyXLeftInStock
```
public GiftCardProductQuery onlyXLeftInStock()
```
    Product stock only x left count
  - openAmountMax
```
public GiftCardProductQuery openAmountMax()
```
    The minimum acceptable value of an open amount gift card.
  - openAmountMin
```
public GiftCardProductQuery openAmountMin()
```
    The minimum acceptable value of an open amount gift card.
  - options
```
public GiftCardProductQuery options(CustomizableOptionInterfaceQueryDefinition queryDef)
```
    An array of options for a customizable product.
  - optionsContainer
```
public GiftCardProductQuery optionsContainer()
```
    If the product has multiple options, determines where they appear on the product page.
  - price
```
@Deprecated
public GiftCardProductQuery price(ProductPricesQueryDefinition queryDef)
```
    Deprecated. Use price_range for product price information.
    
    A ProductPrices object, indicating the price of an item.
  - priceRange
```
public GiftCardProductQuery priceRange(PriceRangeQueryDefinition queryDef)
```
    A PriceRange object, indicating the range of prices for the product
  - priceTiers
```
public GiftCardProductQuery priceTiers(TierPriceQueryDefinition queryDef)
```
    An array of TierPrice objects.
  - productLinks
```
public GiftCardProductQuery productLinks(ProductLinksInterfaceQueryDefinition queryDef)
```
    An array of ProductLinks objects.
  - ratingSummary
```
public GiftCardProductQuery ratingSummary()
```
    The average of all the ratings given to the product.
  - relatedProducts
```
public GiftCardProductQuery relatedProducts(ProductInterfaceQueryDefinition queryDef)
```
    Related Products
  - reviewCount
```
public GiftCardProductQuery reviewCount()
```
    The total count of all the reviews given to the product.
  - reviews
```
public GiftCardProductQuery reviews(ProductReviewsQueryDefinition queryDef)
```
    The list of products reviews.
  - reviews
```
public GiftCardProductQuery reviews(GiftCardProductQuery.ReviewsArgumentsDefinition argsDef,
                                    ProductReviewsQueryDefinition queryDef)
```
    The list of products reviews.
  - shortDescription
```
public GiftCardProductQuery shortDescription(ComplexTextValueQueryDefinition queryDef)
```
    A short description of the product. Its use depends on the theme.
  - sku
```
public GiftCardProductQuery sku()
```
    A number or code assigned to a product to identify the product, options, price, and manufacturer.
  - smallImage
```
public GiftCardProductQuery smallImage(ProductImageQueryDefinition queryDef)
```
    The relative path to the small image, which is used on catalog pages.
  - specialFromDate
```
@Deprecated
public GiftCardProductQuery specialFromDate()
```
    Deprecated. The field should not be used on the storefront.
    
    The beginning date that a product has a special price.
  - specialPrice
```
public GiftCardProductQuery specialPrice()
```
    The discounted price of the product.
  - specialToDate
```
public GiftCardProductQuery specialToDate()
```
    The end date that a product has a special price.
  - staged
```
public GiftCardProductQuery staged()
```
  - stockStatus
```
public GiftCardProductQuery stockStatus()
```
    Stock status of the product
  - swatchImage
```
public GiftCardProductQuery swatchImage()
```
    The file name of a swatch image
  - thumbnail
```
public GiftCardProductQuery thumbnail(ProductImageQueryDefinition queryDef)
```
    The relative path to the product's thumbnail image.
  - tierPrice
```
@Deprecated
public GiftCardProductQuery tierPrice()
```
    Deprecated. Use price_tiers for product tier price information.
    
    The price when tier pricing is in effect and the items purchased threshold has been reached.
  - tierPrices
```
@Deprecated
public GiftCardProductQuery tierPrices(ProductTierPricesQueryDefinition queryDef)
```
    Deprecated. Use price_tiers for product tier price information.
    
    An array of ProductTierPrices objects.
  - typeId
```
@Deprecated
public GiftCardProductQuery typeId()
```
    Deprecated. Use __typename instead.
    
    One of simple, virtual, bundle, downloadable, grouped, or configurable.
  - uid
```
public GiftCardProductQuery uid()
```
    The unique ID for a `ProductInterface` object.
  - updatedAt
```
@Deprecated
public GiftCardProductQuery updatedAt()
```
    Deprecated. The field should not be used on the storefront.
    
    Timestamp indicating when the product was updated.
  - upsellProducts
```
public GiftCardProductQuery upsellProducts(ProductInterfaceQueryDefinition queryDef)
```
    Upsell Products
  - urlKey
```
public GiftCardProductQuery urlKey()
```
    The part of the URL that identifies the product
  - urlPath
```
@Deprecated
public GiftCardProductQuery urlPath()
```
    Deprecated. Use product's `canonical_url` or url rewrites instead
  - urlRewrites
```
public GiftCardProductQuery urlRewrites(UrlRewriteQueryDefinition queryDef)
```
    URL rewrites list
  - urlSuffix
```
public GiftCardProductQuery urlSuffix()
```
    The part of the product URL that is appended after the url key
  - websites
```
@Deprecated
public GiftCardProductQuery websites(WebsiteQueryDefinition queryDef)
```
    Deprecated. The field should not be used on the storefront.
    
    An array of websites in which the product is available.
  - weight
```
public GiftCardProductQuery weight()
```
    The weight of the item, in units defined by the store.
  - createFragment
```
public static Fragment<GiftCardProductQuery> createFragment(String name,
                                                            GiftCardProductQueryDefinition queryDef)
```
    Creates a GraphQL "named" fragment with the specified query type definition. The generics nature of fragments ensures that a fragment can only be used at the right place in the GraphQL request.
    
    Parameters:
    
    name - The name of the fragment, must be unique for a given GraphQL request.
    
    queryDef - The fragment definition.
    
    Returns:
    
    The fragment of a given generics type.
  - addFragmentReference
```
public GiftCardProductQuery addFragmentReference(Fragment<GiftCardProductQuery> fragment)
```
    Adds a GiftCardProductQuery fragment reference at the current position of the query. For example for a fragment named test, calling this method will add the reference ...test in the query. For GraphQL types implementing an interface, there will be some similar methods using the Query type of each implemented interface.
    
    Parameters:
    
    fragment - The fragment to reference.
  - addCustomizableProductInterfaceFragmentReference
```
public GiftCardProductQuery addCustomizableProductInterfaceFragmentReference(Fragment<CustomizableProductInterfaceQuery> fragment)
```
    Adds a CustomizableProductInterfaceQuery fragment reference at the current position of the query. For example for a fragment named test, calling this method will add the reference ...test in the query.
    
    Parameters:
    
    fragment - The fragment to reference.
  - addPhysicalProductInterfaceFragmentReference
```
public GiftCardProductQuery addPhysicalProductInterfaceFragmentReference(Fragment<PhysicalProductInterfaceQuery> fragment)
```
    Adds a PhysicalProductInterfaceQuery fragment reference at the current position of the query. For example for a fragment named test, calling this method will add the reference ...test in the query.
    
    Parameters:
    
    fragment - The fragment to reference.
  - addProductInterfaceFragmentReference
```
public GiftCardProductQuery addProductInterfaceFragmentReference(Fragment<ProductInterfaceQuery> fragment)
```
    Adds a ProductInterfaceQuery fragment reference at the current position of the query. For example for a fragment named test, calling this method will add the reference ...test in the query.
    
    Parameters:
    
    fragment - The fragment to reference.

Class GiftCardProductQuery

Nested Class Summary

Field Summary

Fields inherited from class com.shopify.graphql.support.AbstractQuery

Method Summary

Methods inherited from class com.shopify.graphql.support.AbstractQuery

Methods inherited from class java.lang.Object

Method Detail

allowMessage

allowOpenAmount

attributeSetId

canonicalUrl

categories

color

countryOfManufacture

createdAt

crosssellProducts

description

giftCardOptions

giftMessageAvailable

giftcardAmounts

giftcardType

id

image

isRedeemable

isReturnable

lifetime

manufacturer

mediaGallery

mediaGalleryEntries

messageMaxLength

metaDescription

metaKeyword

metaTitle

name

newFromDate

newToDate

onlyXLeftInStock

openAmountMax

openAmountMin

options

optionsContainer

price

priceRange

priceTiers

productLinks

ratingSummary

relatedProducts

reviewCount

reviews

reviews

shortDescription

sku

smallImage

specialFromDate

specialPrice

specialToDate

staged

stockStatus

swatchImage

thumbnail

tierPrice

tierPrices

typeId

uid

updatedAt

upsellProducts

urlKey

urlPath

urlRewrites

urlSuffix

websites

weight

createFragment

addFragmentReference

addCustomizableProductInterfaceFragmentReference

addPhysicalProductInterfaceFragmentReference

addProductInterfaceFragmentReference