com.shopify.buy3

Class Storefront.ProductQuery

java.lang.Object

<any>

com.shopify.buy3.Storefront.ProductQuery

Enclosing class:

Storefront

public static class Storefront.ProductQuery
extends <any>

A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Storefront.ProductQuery.CollectionsArguments
static interface	Storefront.ProductQuery.CollectionsArgumentsDefinition
class	Storefront.ProductQuery.DescriptionArguments
static interface	Storefront.ProductQuery.DescriptionArgumentsDefinition
class	Storefront.ProductQuery.ImagesArguments
static interface	Storefront.ProductQuery.ImagesArgumentsDefinition
class	Storefront.ProductQuery.MediaArguments
static interface	Storefront.ProductQuery.MediaArgumentsDefinition
class	Storefront.ProductQuery.MetafieldsArguments
static interface	Storefront.ProductQuery.MetafieldsArgumentsDefinition
class	Storefront.ProductQuery.OptionsArguments
static interface	Storefront.ProductQuery.OptionsArgumentsDefinition
class	Storefront.ProductQuery.PresentmentPriceRangesArguments
static interface	Storefront.ProductQuery.PresentmentPriceRangesArgumentsDefinition
class	Storefront.ProductQuery.VariantsArguments
static interface	Storefront.ProductQuery.VariantsArgumentsDefinition

Method Summary

Modifier and Type	Method and Description
Storefront.ProductQuery	availableForSale() Indicates if at least one product variant is available for sale.
Storefront.ProductQuery	collections(Storefront.CollectionConnectionQueryDefinition queryDef) List of collections a product belongs to.
Storefront.ProductQuery	collections(Storefront.ProductQuery.CollectionsArgumentsDefinition argsDef, Storefront.CollectionConnectionQueryDefinition queryDef) List of collections a product belongs to.
Storefront.ProductQuery	compareAtPriceRange(Storefront.ProductPriceRangeQueryDefinition queryDef) The compare at price of the product across all variants.
Storefront.ProductQuery	createdAt() The date and time when the product was created.
Storefront.ProductQuery	description() Stripped description of the product, single line with HTML tags removed.
Storefront.ProductQuery	description(Storefront.ProductQuery.DescriptionArgumentsDefinition argsDef) Stripped description of the product, single line with HTML tags removed.
Storefront.ProductQuery	descriptionHtml() The description of the product, complete with HTML formatting.
Storefront.ProductQuery	handle() A human-friendly unique string for the Product automatically generated from its title.
Storefront.ProductQuery	images(Storefront.ImageConnectionQueryDefinition queryDef) List of images associated with the product.
Storefront.ProductQuery	images(Storefront.ProductQuery.ImagesArgumentsDefinition argsDef, Storefront.ImageConnectionQueryDefinition queryDef) List of images associated with the product.
Storefront.ProductQuery	media(Storefront.MediaConnectionQueryDefinition queryDef) The media associated with the product.
Storefront.ProductQuery	media(Storefront.ProductQuery.MediaArgumentsDefinition argsDef, Storefront.MediaConnectionQueryDefinition queryDef) The media associated with the product.
Storefront.ProductQuery	metafield(java.lang.String namespace, java.lang.String key, Storefront.MetafieldQueryDefinition queryDef) The metafield associated with the resource.
Storefront.ProductQuery	metafields(Storefront.MetafieldConnectionQueryDefinition queryDef) A paginated list of metafields associated with the resource.
Storefront.ProductQuery	metafields(Storefront.ProductQuery.MetafieldsArgumentsDefinition argsDef, Storefront.MetafieldConnectionQueryDefinition queryDef) A paginated list of metafields associated with the resource.
Storefront.ProductQuery	onlineStoreUrl() The online store URL for the product.
Storefront.ProductQuery	options(Storefront.ProductOptionQueryDefinition queryDef) List of product options.
Storefront.ProductQuery	options(Storefront.ProductQuery.OptionsArgumentsDefinition argsDef, Storefront.ProductOptionQueryDefinition queryDef) List of product options.
Storefront.ProductQuery	presentmentPriceRanges(Storefront.ProductPriceRangeConnectionQueryDefinition queryDef) List of price ranges in the presentment currencies for this shop.
Storefront.ProductQuery	presentmentPriceRanges(Storefront.ProductQuery.PresentmentPriceRangesArgumentsDefinition argsDef, Storefront.ProductPriceRangeConnectionQueryDefinition queryDef) List of price ranges in the presentment currencies for this shop.
Storefront.ProductQuery	priceRange(Storefront.ProductPriceRangeQueryDefinition queryDef) The price range.
Storefront.ProductQuery	productType() A categorization that a product can be tagged with, commonly used for filtering and searching.
Storefront.ProductQuery	publishedAt() The date and time when the product was published to the channel.
Storefront.ProductQuery	seo(Storefront.SEOQueryDefinition queryDef) The product's SEO information.
Storefront.ProductQuery	tags() A comma separated list of tags that have been added to the product.
Storefront.ProductQuery	title() The product’s title.
Storefront.ProductQuery	totalInventory() The total quantity of inventory in stock for this Product.
Storefront.ProductQuery	updatedAt() The date and time when the product was last modified.
Storefront.ProductQuery	variantBySelectedOptions(java.util.List<Storefront.SelectedOptionInput> selectedOptions, Storefront.ProductVariantQueryDefinition queryDef) Find a product’s variant based on its selected options.
Storefront.ProductQuery	variants(Storefront.ProductQuery.VariantsArgumentsDefinition argsDef, Storefront.ProductVariantConnectionQueryDefinition queryDef) List of the product’s variants.
Storefront.ProductQuery	variants(Storefront.ProductVariantConnectionQueryDefinition queryDef) List of the product’s variants.
Storefront.ProductQuery	vendor() The product’s vendor name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

availableForSale

public Storefront.ProductQuery availableForSale()

Indicates if at least one product variant is available for sale.

collections

public Storefront.ProductQuery collections(Storefront.CollectionConnectionQueryDefinition queryDef)

List of collections a product belongs to.

collections

public Storefront.ProductQuery collections(Storefront.ProductQuery.CollectionsArgumentsDefinition argsDef,
                                           Storefront.CollectionConnectionQueryDefinition queryDef)

List of collections a product belongs to.

compareAtPriceRange

public Storefront.ProductQuery compareAtPriceRange(Storefront.ProductPriceRangeQueryDefinition queryDef)

The compare at price of the product across all variants.

createdAt

public Storefront.ProductQuery createdAt()

The date and time when the product was created.

description

public Storefront.ProductQuery description()

Stripped description of the product, single line with HTML tags removed.

description

public Storefront.ProductQuery description(Storefront.ProductQuery.DescriptionArgumentsDefinition argsDef)

Stripped description of the product, single line with HTML tags removed.

descriptionHtml

public Storefront.ProductQuery descriptionHtml()

The description of the product, complete with HTML formatting.

handle

public Storefront.ProductQuery handle()

A human-friendly unique string for the Product automatically generated from its title. They are used by the Liquid templating language to refer to objects.

images

public Storefront.ProductQuery images(Storefront.ImageConnectionQueryDefinition queryDef)

List of images associated with the product.

images

public Storefront.ProductQuery images(Storefront.ProductQuery.ImagesArgumentsDefinition argsDef,
                                      Storefront.ImageConnectionQueryDefinition queryDef)

List of images associated with the product.

media

public Storefront.ProductQuery media(Storefront.MediaConnectionQueryDefinition queryDef)

The media associated with the product.

media

public Storefront.ProductQuery media(Storefront.ProductQuery.MediaArgumentsDefinition argsDef,
                                     Storefront.MediaConnectionQueryDefinition queryDef)

The media associated with the product.

metafield

public Storefront.ProductQuery metafield(java.lang.String namespace,
                                         java.lang.String key,
                                         Storefront.MetafieldQueryDefinition queryDef)

The metafield associated with the resource.

metafields

public Storefront.ProductQuery metafields(Storefront.MetafieldConnectionQueryDefinition queryDef)

A paginated list of metafields associated with the resource.

metafields

public Storefront.ProductQuery metafields(Storefront.ProductQuery.MetafieldsArgumentsDefinition argsDef,
                                          Storefront.MetafieldConnectionQueryDefinition queryDef)

A paginated list of metafields associated with the resource.

onlineStoreUrl

public Storefront.ProductQuery onlineStoreUrl()

The online store URL for the product. A value of `null` indicates that the product is not published to the Online Store sales channel.

options

public Storefront.ProductQuery options(Storefront.ProductOptionQueryDefinition queryDef)

List of product options.

options

public Storefront.ProductQuery options(Storefront.ProductQuery.OptionsArgumentsDefinition argsDef,
                                       Storefront.ProductOptionQueryDefinition queryDef)

List of product options.

presentmentPriceRanges

public Storefront.ProductQuery presentmentPriceRanges(Storefront.ProductPriceRangeConnectionQueryDefinition queryDef)

List of price ranges in the presentment currencies for this shop.

presentmentPriceRanges

public Storefront.ProductQuery presentmentPriceRanges(Storefront.ProductQuery.PresentmentPriceRangesArgumentsDefinition argsDef,
                                                      Storefront.ProductPriceRangeConnectionQueryDefinition queryDef)

List of price ranges in the presentment currencies for this shop.

priceRange

public Storefront.ProductQuery priceRange(Storefront.ProductPriceRangeQueryDefinition queryDef)

The price range.

productType

public Storefront.ProductQuery productType()

A categorization that a product can be tagged with, commonly used for filtering and searching.

publishedAt

public Storefront.ProductQuery publishedAt()

The date and time when the product was published to the channel.

seo

public Storefront.ProductQuery seo(Storefront.SEOQueryDefinition queryDef)

The product's SEO information.

tags

public Storefront.ProductQuery tags()

A comma separated list of tags that have been added to the product. Additional access scope required for private apps: unauthenticated_read_product_tags.

title

public Storefront.ProductQuery title()

The product’s title.

totalInventory

public Storefront.ProductQuery totalInventory()

The total quantity of inventory in stock for this Product.

updatedAt

public Storefront.ProductQuery updatedAt()

The date and time when the product was last modified. A product's `updatedAt` value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update.

variantBySelectedOptions

public Storefront.ProductQuery variantBySelectedOptions(java.util.List<Storefront.SelectedOptionInput> selectedOptions,
                                                        Storefront.ProductVariantQueryDefinition queryDef)

Find a product’s variant based on its selected options. This is useful for converting a user’s selection of product options into a single matching variant. If there is not a variant for the selected options, `null` will be returned.

variants

public Storefront.ProductQuery variants(Storefront.ProductVariantConnectionQueryDefinition queryDef)

List of the product’s variants.

variants

public Storefront.ProductQuery variants(Storefront.ProductQuery.VariantsArgumentsDefinition argsDef,
                                        Storefront.ProductVariantConnectionQueryDefinition queryDef)

List of the product’s variants.

vendor

public Storefront.ProductQuery vendor()

The product’s vendor name.