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

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

```
public class ConfigurableProductQuery
extends AbstractQuery<ConfigurableProductQuery>
```
ConfigurableProduct defines basic features of a configurable product and its simple product variants

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`ConfigurableProductQuery.ConfigurableProductOptionsSelectionArguments`
`static interface`	`ConfigurableProductQuery.ConfigurableProductOptionsSelectionArgumentsDefinition`
`class`	`ConfigurableProductQuery.ReviewsArguments`
`static interface`	`ConfigurableProductQuery.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
`ConfigurableProductQuery`	`addCustomizableProductInterfaceFragmentReference(Fragment<CustomizableProductInterfaceQuery> fragment)` Adds a `CustomizableProductInterfaceQuery` fragment reference at the current position of the query.
`ConfigurableProductQuery`	`addFragmentReference(Fragment<ConfigurableProductQuery> fragment)` Adds a `ConfigurableProductQuery` fragment reference at the current position of the query.
`ConfigurableProductQuery`	`addPhysicalProductInterfaceFragmentReference(Fragment<PhysicalProductInterfaceQuery> fragment)` Adds a `PhysicalProductInterfaceQuery` fragment reference at the current position of the query.
`ConfigurableProductQuery`	`addProductInterfaceFragmentReference(Fragment<ProductInterfaceQuery> fragment)` Adds a `ProductInterfaceQuery` fragment reference at the current position of the query.
`ConfigurableProductQuery`	`attributeSetId()` Deprecated. The field should not be used on the storefront.
`ConfigurableProductQuery`	`canonicalUrl()` Relative canonical URL.
`ConfigurableProductQuery`	`categories(CategoryInterfaceQueryDefinition queryDef)` The categories assigned to a product.
`ConfigurableProductQuery`	`color()`
`ConfigurableProductQuery`	`configurableOptions(ConfigurableProductOptionsQueryDefinition queryDef)` An array of linked simple product items
`ConfigurableProductQuery`	`configurableProductOptionsSelection(ConfigurableProductOptionsSelectionQueryDefinition queryDef)` Metadata for the specified configurable options selection
`ConfigurableProductQuery`	`configurableProductOptionsSelection(ConfigurableProductQuery.ConfigurableProductOptionsSelectionArgumentsDefinition argsDef, ConfigurableProductOptionsSelectionQueryDefinition queryDef)` Metadata for the specified configurable options selection
`ConfigurableProductQuery`	`countryOfManufacture()` The product's country of origin.
`ConfigurableProductQuery`	`createdAt()` Deprecated. The field should not be used on the storefront.
`static Fragment<ConfigurableProductQuery>`	`createFragment(String name, ConfigurableProductQueryDefinition queryDef)` Creates a GraphQL "named" fragment with the specified query type definition.
`ConfigurableProductQuery`	`crosssellProducts(ProductInterfaceQueryDefinition queryDef)` Crosssell Products
`ConfigurableProductQuery`	`description(ComplexTextValueQueryDefinition queryDef)` Detailed information about the product.
`ConfigurableProductQuery`	`giftMessageAvailable()` Indicates whether a gift message is available.
`ConfigurableProductQuery`	`id()` Deprecated. Use the `uid` field instead.
`ConfigurableProductQuery`	`image(ProductImageQueryDefinition queryDef)` The relative path to the main image on the product page.
`ConfigurableProductQuery`	`isReturnable()` Indicates whether the product can be returned
`ConfigurableProductQuery`	`manufacturer()` A number representing the product's manufacturer.
`ConfigurableProductQuery`	`mediaGallery(MediaGalleryInterfaceQueryDefinition queryDef)` An array of Media Gallery objects.
`ConfigurableProductQuery`	`mediaGalleryEntries(MediaGalleryEntryQueryDefinition queryDef)` Deprecated. Use product's `media_gallery` instead
`ConfigurableProductQuery`	`metaDescription()` A brief overview of the product for search results listings, maximum 255 characters.
`ConfigurableProductQuery`	`metaKeyword()` A comma-separated list of keywords that are visible only to search engines.
`ConfigurableProductQuery`	`metaTitle()` A string that is displayed in the title bar and tab of the browser and in search results lists.
`ConfigurableProductQuery`	`name()` The product name.
`ConfigurableProductQuery`	`newFromDate()` Deprecated. The field should not be used on the storefront.
`ConfigurableProductQuery`	`newToDate()` Deprecated. The field should not be used on the storefront.
`ConfigurableProductQuery`	`onlyXLeftInStock()` Product stock only x left count
`ConfigurableProductQuery`	`options(CustomizableOptionInterfaceQueryDefinition queryDef)` An array of options for a customizable product.
`ConfigurableProductQuery`	`optionsContainer()` If the product has multiple options, determines where they appear on the product page.
`ConfigurableProductQuery`	`price(ProductPricesQueryDefinition queryDef)` Deprecated. Use price_range for product price information.
`ConfigurableProductQuery`	`priceRange(PriceRangeQueryDefinition queryDef)` A PriceRange object, indicating the range of prices for the product
`ConfigurableProductQuery`	`priceTiers(TierPriceQueryDefinition queryDef)` An array of TierPrice objects.
`ConfigurableProductQuery`	`productLinks(ProductLinksInterfaceQueryDefinition queryDef)` An array of ProductLinks objects.
`ConfigurableProductQuery`	`ratingSummary()` The average of all the ratings given to the product.
`ConfigurableProductQuery`	`relatedProducts(ProductInterfaceQueryDefinition queryDef)` Related Products
`ConfigurableProductQuery`	`reviewCount()` The total count of all the reviews given to the product.
`ConfigurableProductQuery`	`reviews(ConfigurableProductQuery.ReviewsArgumentsDefinition argsDef, ProductReviewsQueryDefinition queryDef)` The list of products reviews.
`ConfigurableProductQuery`	`reviews(ProductReviewsQueryDefinition queryDef)` The list of products reviews.
`ConfigurableProductQuery`	`shortDescription(ComplexTextValueQueryDefinition queryDef)` A short description of the product.
`ConfigurableProductQuery`	`sku()` A number or code assigned to a product to identify the product, options, price, and manufacturer.
`ConfigurableProductQuery`	`smallImage(ProductImageQueryDefinition queryDef)` The relative path to the small image, which is used on catalog pages.
`ConfigurableProductQuery`	`specialFromDate()` Deprecated. The field should not be used on the storefront.
`ConfigurableProductQuery`	`specialPrice()` The discounted price of the product.
`ConfigurableProductQuery`	`specialToDate()` The end date that a product has a special price.
`ConfigurableProductQuery`	`staged()`
`ConfigurableProductQuery`	`stockStatus()` Stock status of the product
`ConfigurableProductQuery`	`swatchImage()` The file name of a swatch image
`ConfigurableProductQuery`	`thumbnail(ProductImageQueryDefinition queryDef)` The relative path to the product's thumbnail image.
`ConfigurableProductQuery`	`tierPrice()` Deprecated. Use price_tiers for product tier price information.
`ConfigurableProductQuery`	`tierPrices(ProductTierPricesQueryDefinition queryDef)` Deprecated. Use price_tiers for product tier price information.
`ConfigurableProductQuery`	`typeId()` Deprecated. Use __typename instead.
`ConfigurableProductQuery`	`uid()` The unique ID for a `ProductInterface` object.
`ConfigurableProductQuery`	`updatedAt()` Deprecated. The field should not be used on the storefront.
`ConfigurableProductQuery`	`upsellProducts(ProductInterfaceQueryDefinition queryDef)` Upsell Products
`ConfigurableProductQuery`	`urlKey()` The part of the URL that identifies the product
`ConfigurableProductQuery`	`urlPath()` Deprecated. Use product's `canonical_url` or url rewrites instead
`ConfigurableProductQuery`	`urlRewrites(UrlRewriteQueryDefinition queryDef)` URL rewrites list
`ConfigurableProductQuery`	`urlSuffix()` The part of the product URL that is appended after the url key
`ConfigurableProductQuery`	`variants(ConfigurableVariantQueryDefinition queryDef)` An array of variants of products
`ConfigurableProductQuery`	`websites(WebsiteQueryDefinition queryDef)` Deprecated. The field should not be used on the storefront.
`ConfigurableProductQuery`	`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
  - attributeSetId
```
@Deprecated
public ConfigurableProductQuery attributeSetId()
```
    Deprecated. The field should not be used on the storefront.
    
    The attribute set assigned to the product.
  - canonicalUrl
```
public ConfigurableProductQuery canonicalUrl()
```
    Relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled
  - categories
```
public ConfigurableProductQuery categories(CategoryInterfaceQueryDefinition queryDef)
```
    The categories assigned to a product.
  - color
```
public ConfigurableProductQuery color()
```
  - configurableOptions
```
public ConfigurableProductQuery configurableOptions(ConfigurableProductOptionsQueryDefinition queryDef)
```
    An array of linked simple product items
  - configurableProductOptionsSelection
```
public ConfigurableProductQuery configurableProductOptionsSelection(ConfigurableProductOptionsSelectionQueryDefinition queryDef)
```
    Metadata for the specified configurable options selection
  - configurableProductOptionsSelection
```
public ConfigurableProductQuery configurableProductOptionsSelection(ConfigurableProductQuery.ConfigurableProductOptionsSelectionArgumentsDefinition argsDef,
                                                                    ConfigurableProductOptionsSelectionQueryDefinition queryDef)
```
    Metadata for the specified configurable options selection
  - countryOfManufacture
```
public ConfigurableProductQuery countryOfManufacture()
```
    The product's country of origin.
  - createdAt
```
@Deprecated
public ConfigurableProductQuery createdAt()
```
    Deprecated. The field should not be used on the storefront.
    
    Timestamp indicating when the product was created.
  - crosssellProducts
```
public ConfigurableProductQuery crosssellProducts(ProductInterfaceQueryDefinition queryDef)
```
    Crosssell Products
  - description
```
public ConfigurableProductQuery description(ComplexTextValueQueryDefinition queryDef)
```
    Detailed information about the product. The value can include simple HTML tags.
  - giftMessageAvailable
```
public ConfigurableProductQuery giftMessageAvailable()
```
    Indicates whether a gift message is available.
  - id
```
@Deprecated
public ConfigurableProductQuery id()
```
    Deprecated. Use the `uid` field instead.
    
    The ID number assigned to the product.
  - image
```
public ConfigurableProductQuery image(ProductImageQueryDefinition queryDef)
```
    The relative path to the main image on the product page.
  - isReturnable
```
public ConfigurableProductQuery isReturnable()
```
    Indicates whether the product can be returned
  - manufacturer
```
public ConfigurableProductQuery manufacturer()
```
    A number representing the product's manufacturer.
  - mediaGallery
```
public ConfigurableProductQuery mediaGallery(MediaGalleryInterfaceQueryDefinition queryDef)
```
    An array of Media Gallery objects.
  - mediaGalleryEntries
```
@Deprecated
public ConfigurableProductQuery mediaGalleryEntries(MediaGalleryEntryQueryDefinition queryDef)
```
    Deprecated. Use product's `media_gallery` instead
    
    An array of MediaGalleryEntry objects.
  - metaDescription
```
public ConfigurableProductQuery metaDescription()
```
    A brief overview of the product for search results listings, maximum 255 characters.
  - metaKeyword
```
public ConfigurableProductQuery metaKeyword()
```
    A comma-separated list of keywords that are visible only to search engines.
  - metaTitle
```
public ConfigurableProductQuery metaTitle()
```
    A string that is displayed in the title bar and tab of the browser and in search results lists.
  - name
```
public ConfigurableProductQuery name()
```
    The product name. Customers use this name to identify the product.
  - newFromDate
```
@Deprecated
public ConfigurableProductQuery 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 ConfigurableProductQuery newToDate()
```
    Deprecated. The field should not be used on the storefront.
    
    The end date for new product listings.
  - onlyXLeftInStock
```
public ConfigurableProductQuery onlyXLeftInStock()
```
    Product stock only x left count
  - options
```
public ConfigurableProductQuery options(CustomizableOptionInterfaceQueryDefinition queryDef)
```
    An array of options for a customizable product.
  - optionsContainer
```
public ConfigurableProductQuery optionsContainer()
```
    If the product has multiple options, determines where they appear on the product page.
  - price
```
@Deprecated
public ConfigurableProductQuery price(ProductPricesQueryDefinition queryDef)
```
    Deprecated. Use price_range for product price information.
    
    A ProductPrices object, indicating the price of an item.
  - priceRange
```
public ConfigurableProductQuery priceRange(PriceRangeQueryDefinition queryDef)
```
    A PriceRange object, indicating the range of prices for the product
  - priceTiers
```
public ConfigurableProductQuery priceTiers(TierPriceQueryDefinition queryDef)
```
    An array of TierPrice objects.
  - productLinks
```
public ConfigurableProductQuery productLinks(ProductLinksInterfaceQueryDefinition queryDef)
```
    An array of ProductLinks objects.
  - ratingSummary
```
public ConfigurableProductQuery ratingSummary()
```
    The average of all the ratings given to the product.
  - relatedProducts
```
public ConfigurableProductQuery relatedProducts(ProductInterfaceQueryDefinition queryDef)
```
    Related Products
  - reviewCount
```
public ConfigurableProductQuery reviewCount()
```
    The total count of all the reviews given to the product.
  - reviews
```
public ConfigurableProductQuery reviews(ProductReviewsQueryDefinition queryDef)
```
    The list of products reviews.
  - reviews
```
public ConfigurableProductQuery reviews(ConfigurableProductQuery.ReviewsArgumentsDefinition argsDef,
                                        ProductReviewsQueryDefinition queryDef)
```
    The list of products reviews.
  - shortDescription
```
public ConfigurableProductQuery shortDescription(ComplexTextValueQueryDefinition queryDef)
```
    A short description of the product. Its use depends on the theme.
  - sku
```
public ConfigurableProductQuery sku()
```
    A number or code assigned to a product to identify the product, options, price, and manufacturer.
  - smallImage
```
public ConfigurableProductQuery smallImage(ProductImageQueryDefinition queryDef)
```
    The relative path to the small image, which is used on catalog pages.
  - specialFromDate
```
@Deprecated
public ConfigurableProductQuery specialFromDate()
```
    Deprecated. The field should not be used on the storefront.
    
    The beginning date that a product has a special price.
  - specialPrice
```
public ConfigurableProductQuery specialPrice()
```
    The discounted price of the product.
  - specialToDate
```
public ConfigurableProductQuery specialToDate()
```
    The end date that a product has a special price.
  - staged
```
public ConfigurableProductQuery staged()
```
  - stockStatus
```
public ConfigurableProductQuery stockStatus()
```
    Stock status of the product
  - swatchImage
```
public ConfigurableProductQuery swatchImage()
```
    The file name of a swatch image
  - thumbnail
```
public ConfigurableProductQuery thumbnail(ProductImageQueryDefinition queryDef)
```
    The relative path to the product's thumbnail image.
  - tierPrice
```
@Deprecated
public ConfigurableProductQuery 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 ConfigurableProductQuery tierPrices(ProductTierPricesQueryDefinition queryDef)
```
    Deprecated. Use price_tiers for product tier price information.
    
    An array of ProductTierPrices objects.
  - typeId
```
@Deprecated
public ConfigurableProductQuery typeId()
```
    Deprecated. Use __typename instead.
    
    One of simple, virtual, bundle, downloadable, grouped, or configurable.
  - uid
```
public ConfigurableProductQuery uid()
```
    The unique ID for a `ProductInterface` object.
  - updatedAt
```
@Deprecated
public ConfigurableProductQuery updatedAt()
```
    Deprecated. The field should not be used on the storefront.
    
    Timestamp indicating when the product was updated.
  - upsellProducts
```
public ConfigurableProductQuery upsellProducts(ProductInterfaceQueryDefinition queryDef)
```
    Upsell Products
  - urlKey
```
public ConfigurableProductQuery urlKey()
```
    The part of the URL that identifies the product
  - urlPath
```
@Deprecated
public ConfigurableProductQuery urlPath()
```
    Deprecated. Use product's `canonical_url` or url rewrites instead
  - urlRewrites
```
public ConfigurableProductQuery urlRewrites(UrlRewriteQueryDefinition queryDef)
```
    URL rewrites list
  - urlSuffix
```
public ConfigurableProductQuery urlSuffix()
```
    The part of the product URL that is appended after the url key
  - variants
```
public ConfigurableProductQuery variants(ConfigurableVariantQueryDefinition queryDef)
```
    An array of variants of products
  - websites
```
@Deprecated
public ConfigurableProductQuery 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 ConfigurableProductQuery weight()
```
    The weight of the item, in units defined by the store.
  - createFragment
```
public static Fragment<ConfigurableProductQuery> createFragment(String name,
                                                                ConfigurableProductQueryDefinition 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 ConfigurableProductQuery addFragmentReference(Fragment<ConfigurableProductQuery> fragment)
```
    Adds a ConfigurableProductQuery 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 ConfigurableProductQuery 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 ConfigurableProductQuery 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 ConfigurableProductQuery 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 ConfigurableProductQuery

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

attributeSetId

canonicalUrl

categories

color

configurableOptions

configurableProductOptionsSelection

configurableProductOptionsSelection

countryOfManufacture

createdAt

crosssellProducts

description

giftMessageAvailable

id

image

isReturnable

manufacturer

mediaGallery

mediaGalleryEntries

metaDescription

metaKeyword

metaTitle

name

newFromDate

newToDate

onlyXLeftInStock

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

variants

websites

weight

createFragment

addFragmentReference

addCustomizableProductInterfaceFragmentReference

addPhysicalProductInterfaceFragmentReference

addProductInterfaceFragmentReference