com.adobe.cq.commerce.magento.graphql

Class ProductInterfaceQuery

java.lang.Object

com.shopify.graphql.support.AbstractQuery<ProductInterfaceQuery>

com.adobe.cq.commerce.magento.graphql.ProductInterfaceQuery

public class ProductInterfaceQuery
extends AbstractQuery<ProductInterfaceQuery>

The ProductInterface contains attributes that are common to all types of products. Note that descriptions may not be available for custom and EAV attributes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ProductInterfaceQuery.ReviewsArguments
static interface	ProductInterfaceQuery.ReviewsArgumentsDefinition

Field Summary

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

_queryBuilder, ALIAS_SUFFIX_SEPARATOR, CUSTOM_FIELD_LABEL

Method Summary

Modifier and Type	Method and Description
ProductInterfaceQuery	addFragmentReference(Fragment<ProductInterfaceQuery> fragment) Adds a ProductInterfaceQuery fragment reference at the current position of the query.
ProductInterfaceQuery	attributeSetId() Deprecated. The field should not be used on the storefront.
ProductInterfaceQuery	canonicalUrl() Relative canonical URL.
ProductInterfaceQuery	categories(CategoryInterfaceQueryDefinition queryDef) The categories assigned to a product.
ProductInterfaceQuery	color()
ProductInterfaceQuery	countryOfManufacture() The product's country of origin.
ProductInterfaceQuery	createdAt() Deprecated. The field should not be used on the storefront.
static Fragment<ProductInterfaceQuery>	createFragment(String name, ProductInterfaceQueryDefinition queryDef) Creates a GraphQL "named" fragment with the specified query type definition.
ProductInterfaceQuery	crosssellProducts(ProductInterfaceQueryDefinition queryDef) Crosssell Products
ProductInterfaceQuery	description(ComplexTextValueQueryDefinition queryDef) Detailed information about the product.
ProductInterfaceQuery	giftMessageAvailable() Indicates whether a gift message is available.
ProductInterfaceQuery	id() Deprecated. Use the `uid` field instead.
ProductInterfaceQuery	image(ProductImageQueryDefinition queryDef) The relative path to the main image on the product page.
ProductInterfaceQuery	isReturnable() Indicates whether the product can be returned
ProductInterfaceQuery	manufacturer() A number representing the product's manufacturer.
ProductInterfaceQuery	mediaGallery(MediaGalleryInterfaceQueryDefinition queryDef) An array of Media Gallery objects.
ProductInterfaceQuery	mediaGalleryEntries(MediaGalleryEntryQueryDefinition queryDef) Deprecated. Use product's `media_gallery` instead
ProductInterfaceQuery	metaDescription() A brief overview of the product for search results listings, maximum 255 characters.
ProductInterfaceQuery	metaKeyword() A comma-separated list of keywords that are visible only to search engines.
ProductInterfaceQuery	metaTitle() A string that is displayed in the title bar and tab of the browser and in search results lists.
ProductInterfaceQuery	name() The product name.
ProductInterfaceQuery	newFromDate() Deprecated. The field should not be used on the storefront.
ProductInterfaceQuery	newToDate() Deprecated. The field should not be used on the storefront.
ProductInterfaceQuery	onBundleProduct(BundleProductQueryDefinition queryDef)
ProductInterfaceQuery	onConfigurableProduct(ConfigurableProductQueryDefinition queryDef)
ProductInterfaceQuery	onCustomizableProductInterface(CustomizableProductInterfaceQueryDefinition queryDef)
ProductInterfaceQuery	onDownloadableProduct(DownloadableProductQueryDefinition queryDef)
ProductInterfaceQuery	onGiftCardProduct(GiftCardProductQueryDefinition queryDef)
ProductInterfaceQuery	onGroupedProduct(GroupedProductQueryDefinition queryDef)
ProductInterfaceQuery	onlyXLeftInStock() Product stock only x left count
ProductInterfaceQuery	onPhysicalProductInterface(PhysicalProductInterfaceQueryDefinition queryDef)
ProductInterfaceQuery	onSimpleProduct(SimpleProductQueryDefinition queryDef)
ProductInterfaceQuery	onVirtualProduct(VirtualProductQueryDefinition queryDef)
ProductInterfaceQuery	optionsContainer() If the product has multiple options, determines where they appear on the product page.
ProductInterfaceQuery	price(ProductPricesQueryDefinition queryDef) Deprecated. Use price_range for product price information.
ProductInterfaceQuery	priceRange(PriceRangeQueryDefinition queryDef) A PriceRange object, indicating the range of prices for the product
ProductInterfaceQuery	priceTiers(TierPriceQueryDefinition queryDef) An array of TierPrice objects.
ProductInterfaceQuery	productLinks(ProductLinksInterfaceQueryDefinition queryDef) An array of ProductLinks objects.
ProductInterfaceQuery	ratingSummary() The average of all the ratings given to the product.
ProductInterfaceQuery	relatedProducts(ProductInterfaceQueryDefinition queryDef) Related Products
ProductInterfaceQuery	reviewCount() The total count of all the reviews given to the product.
ProductInterfaceQuery	reviews(ProductInterfaceQuery.ReviewsArgumentsDefinition argsDef, ProductReviewsQueryDefinition queryDef) The list of products reviews.
ProductInterfaceQuery	reviews(ProductReviewsQueryDefinition queryDef) The list of products reviews.
ProductInterfaceQuery	shortDescription(ComplexTextValueQueryDefinition queryDef) A short description of the product.
ProductInterfaceQuery	sku() A number or code assigned to a product to identify the product, options, price, and manufacturer.
ProductInterfaceQuery	smallImage(ProductImageQueryDefinition queryDef) The relative path to the small image, which is used on catalog pages.
ProductInterfaceQuery	specialFromDate() Deprecated. The field should not be used on the storefront.
ProductInterfaceQuery	specialPrice() The discounted price of the product.
ProductInterfaceQuery	specialToDate() The end date that a product has a special price.
ProductInterfaceQuery	staged()
ProductInterfaceQuery	stockStatus() Stock status of the product
ProductInterfaceQuery	swatchImage() The file name of a swatch image
ProductInterfaceQuery	thumbnail(ProductImageQueryDefinition queryDef) The relative path to the product's thumbnail image.
ProductInterfaceQuery	tierPrice() Deprecated. Use price_tiers for product tier price information.
ProductInterfaceQuery	tierPrices(ProductTierPricesQueryDefinition queryDef) Deprecated. Use price_tiers for product tier price information.
ProductInterfaceQuery	typeId() Deprecated. Use __typename instead.
ProductInterfaceQuery	uid() The unique ID for a `ProductInterface` object.
ProductInterfaceQuery	updatedAt() Deprecated. The field should not be used on the storefront.
ProductInterfaceQuery	upsellProducts(ProductInterfaceQueryDefinition queryDef) Upsell Products
ProductInterfaceQuery	urlKey() The part of the URL that identifies the product
ProductInterfaceQuery	urlPath() Deprecated. Use product's `canonical_url` or url rewrites instead
ProductInterfaceQuery	urlRewrites(UrlRewriteQueryDefinition queryDef) URL rewrites list
ProductInterfaceQuery	urlSuffix() The part of the product URL that is appended after the url key
ProductInterfaceQuery	websites(WebsiteQueryDefinition queryDef) Deprecated. The field should not be used on the storefront.

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 ProductInterfaceQuery attributeSetId()

Deprecated. The field should not be used on the storefront.

The attribute set assigned to the product.

canonicalUrl

public ProductInterfaceQuery canonicalUrl()

Relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled

categories

public ProductInterfaceQuery categories(CategoryInterfaceQueryDefinition queryDef)

The categories assigned to a product.

color

public ProductInterfaceQuery color()

countryOfManufacture

public ProductInterfaceQuery countryOfManufacture()

The product's country of origin.

createdAt

@Deprecated
public ProductInterfaceQuery createdAt()

Deprecated. The field should not be used on the storefront.

Timestamp indicating when the product was created.

crosssellProducts

public ProductInterfaceQuery crosssellProducts(ProductInterfaceQueryDefinition queryDef)

Crosssell Products

description

public ProductInterfaceQuery description(ComplexTextValueQueryDefinition queryDef)

Detailed information about the product. The value can include simple HTML tags.

giftMessageAvailable

public ProductInterfaceQuery giftMessageAvailable()

Indicates whether a gift message is available.

id

@Deprecated
public ProductInterfaceQuery id()

Deprecated. Use the `uid` field instead.

The ID number assigned to the product.

image

public ProductInterfaceQuery image(ProductImageQueryDefinition queryDef)

The relative path to the main image on the product page.

isReturnable

public ProductInterfaceQuery isReturnable()

Indicates whether the product can be returned

manufacturer

public ProductInterfaceQuery manufacturer()

A number representing the product's manufacturer.

mediaGallery

public ProductInterfaceQuery mediaGallery(MediaGalleryInterfaceQueryDefinition queryDef)

An array of Media Gallery objects.

mediaGalleryEntries

@Deprecated
public ProductInterfaceQuery mediaGalleryEntries(MediaGalleryEntryQueryDefinition queryDef)

Deprecated. Use product's `media_gallery` instead

An array of MediaGalleryEntry objects.

metaDescription

public ProductInterfaceQuery metaDescription()

A brief overview of the product for search results listings, maximum 255 characters.

metaKeyword

public ProductInterfaceQuery metaKeyword()

A comma-separated list of keywords that are visible only to search engines.

metaTitle

public ProductInterfaceQuery metaTitle()

A string that is displayed in the title bar and tab of the browser and in search results lists.

name

public ProductInterfaceQuery name()

The product name. Customers use this name to identify the product.

newFromDate

@Deprecated
public ProductInterfaceQuery 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 ProductInterfaceQuery newToDate()

Deprecated. The field should not be used on the storefront.

The end date for new product listings.

onlyXLeftInStock

public ProductInterfaceQuery onlyXLeftInStock()

Product stock only x left count

optionsContainer

public ProductInterfaceQuery optionsContainer()

If the product has multiple options, determines where they appear on the product page.

price

@Deprecated
public ProductInterfaceQuery price(ProductPricesQueryDefinition queryDef)

Deprecated. Use price_range for product price information.

A ProductPrices object, indicating the price of an item.

priceRange

public ProductInterfaceQuery priceRange(PriceRangeQueryDefinition queryDef)

A PriceRange object, indicating the range of prices for the product

priceTiers

public ProductInterfaceQuery priceTiers(TierPriceQueryDefinition queryDef)

An array of TierPrice objects.

productLinks

public ProductInterfaceQuery productLinks(ProductLinksInterfaceQueryDefinition queryDef)

An array of ProductLinks objects.

ratingSummary

public ProductInterfaceQuery ratingSummary()

The average of all the ratings given to the product.

relatedProducts

public ProductInterfaceQuery relatedProducts(ProductInterfaceQueryDefinition queryDef)

Related Products

reviewCount

public ProductInterfaceQuery reviewCount()

The total count of all the reviews given to the product.

reviews

public ProductInterfaceQuery reviews(ProductReviewsQueryDefinition queryDef)

The list of products reviews.

reviews

public ProductInterfaceQuery reviews(ProductInterfaceQuery.ReviewsArgumentsDefinition argsDef,
                                     ProductReviewsQueryDefinition queryDef)

The list of products reviews.

shortDescription

public ProductInterfaceQuery shortDescription(ComplexTextValueQueryDefinition queryDef)

A short description of the product. Its use depends on the theme.

sku

public ProductInterfaceQuery sku()

A number or code assigned to a product to identify the product, options, price, and manufacturer.

smallImage

public ProductInterfaceQuery smallImage(ProductImageQueryDefinition queryDef)

The relative path to the small image, which is used on catalog pages.

specialFromDate

@Deprecated
public ProductInterfaceQuery specialFromDate()

Deprecated. The field should not be used on the storefront.

The beginning date that a product has a special price.

specialPrice

public ProductInterfaceQuery specialPrice()

The discounted price of the product.

specialToDate

public ProductInterfaceQuery specialToDate()

The end date that a product has a special price.

staged

public ProductInterfaceQuery staged()

stockStatus

public ProductInterfaceQuery stockStatus()

Stock status of the product

swatchImage

public ProductInterfaceQuery swatchImage()

The file name of a swatch image

thumbnail

public ProductInterfaceQuery thumbnail(ProductImageQueryDefinition queryDef)

The relative path to the product's thumbnail image.

tierPrice

@Deprecated
public ProductInterfaceQuery 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 ProductInterfaceQuery tierPrices(ProductTierPricesQueryDefinition queryDef)

Deprecated. Use price_tiers for product tier price information.

An array of ProductTierPrices objects.

typeId

@Deprecated
public ProductInterfaceQuery typeId()

Deprecated. Use __typename instead.

One of simple, virtual, bundle, downloadable, grouped, or configurable.

uid

public ProductInterfaceQuery uid()

The unique ID for a `ProductInterface` object.

updatedAt

@Deprecated
public ProductInterfaceQuery updatedAt()

Deprecated. The field should not be used on the storefront.

Timestamp indicating when the product was updated.

upsellProducts

public ProductInterfaceQuery upsellProducts(ProductInterfaceQueryDefinition queryDef)

Upsell Products

urlKey

public ProductInterfaceQuery urlKey()

The part of the URL that identifies the product

urlPath

@Deprecated
public ProductInterfaceQuery urlPath()

Deprecated. Use product's `canonical_url` or url rewrites instead

urlRewrites

public ProductInterfaceQuery urlRewrites(UrlRewriteQueryDefinition queryDef)

URL rewrites list

urlSuffix

public ProductInterfaceQuery urlSuffix()

The part of the product URL that is appended after the url key

websites

@Deprecated
public ProductInterfaceQuery websites(WebsiteQueryDefinition queryDef)

Deprecated. The field should not be used on the storefront.

An array of websites in which the product is available.

onBundleProduct

public ProductInterfaceQuery onBundleProduct(BundleProductQueryDefinition queryDef)

onConfigurableProduct

public ProductInterfaceQuery onConfigurableProduct(ConfigurableProductQueryDefinition queryDef)

onDownloadableProduct

public ProductInterfaceQuery onDownloadableProduct(DownloadableProductQueryDefinition queryDef)

onGiftCardProduct

public ProductInterfaceQuery onGiftCardProduct(GiftCardProductQueryDefinition queryDef)

onGroupedProduct

public ProductInterfaceQuery onGroupedProduct(GroupedProductQueryDefinition queryDef)

onSimpleProduct

public ProductInterfaceQuery onSimpleProduct(SimpleProductQueryDefinition queryDef)

onVirtualProduct

public ProductInterfaceQuery onVirtualProduct(VirtualProductQueryDefinition queryDef)

onCustomizableProductInterface

public ProductInterfaceQuery onCustomizableProductInterface(CustomizableProductInterfaceQueryDefinition queryDef)

onPhysicalProductInterface

public ProductInterfaceQuery onPhysicalProductInterface(PhysicalProductInterfaceQueryDefinition queryDef)

createFragment

public static Fragment<ProductInterfaceQuery> createFragment(String name,
                                                             ProductInterfaceQueryDefinition 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 ProductInterfaceQuery addFragmentReference(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. 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.