com.shopify.buy3

Class Storefront.ProductVariantQuery

java.lang.Object

<any>

com.shopify.buy3.Storefront.ProductVariantQuery

Enclosing class:

Storefront

public static class Storefront.ProductVariantQuery
extends <any>

A product variant represents a different version of a product, such as differing sizes or differing colors.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Storefront.ProductVariantQuery.ImageArguments
static interface	Storefront.ProductVariantQuery.ImageArgumentsDefinition
class	Storefront.ProductVariantQuery.MetafieldsArguments
static interface	Storefront.ProductVariantQuery.MetafieldsArgumentsDefinition
class	Storefront.ProductVariantQuery.PresentmentPricesArguments
static interface	Storefront.ProductVariantQuery.PresentmentPricesArgumentsDefinition
class	Storefront.ProductVariantQuery.PresentmentUnitPricesArguments
static interface	Storefront.ProductVariantQuery.PresentmentUnitPricesArgumentsDefinition

Method Summary

Modifier and Type	Method and Description
Storefront.ProductVariantQuery	available() Deprecated. Use `availableForSale` instead
Storefront.ProductVariantQuery	availableForSale() Indicates if the product variant is available for sale.
Storefront.ProductVariantQuery	compareAtPrice() Deprecated. Use `compareAtPriceV2` instead
Storefront.ProductVariantQuery	compareAtPriceV2(Storefront.MoneyV2QueryDefinition queryDef) The compare at price of the variant.
Storefront.ProductVariantQuery	currentlyNotInStock() Whether a product is out of stock but still available for purchase (used for backorders).
Storefront.ProductVariantQuery	image(Storefront.ImageQueryDefinition queryDef) Image associated with the product variant.
Storefront.ProductVariantQuery	image(Storefront.ProductVariantQuery.ImageArgumentsDefinition argsDef, Storefront.ImageQueryDefinition queryDef) Image associated with the product variant.
Storefront.ProductVariantQuery	metafield(java.lang.String namespace, java.lang.String key, Storefront.MetafieldQueryDefinition queryDef) The metafield associated with the resource.
Storefront.ProductVariantQuery	metafields(Storefront.MetafieldConnectionQueryDefinition queryDef) A paginated list of metafields associated with the resource.
Storefront.ProductVariantQuery	metafields(Storefront.ProductVariantQuery.MetafieldsArgumentsDefinition argsDef, Storefront.MetafieldConnectionQueryDefinition queryDef) A paginated list of metafields associated with the resource.
Storefront.ProductVariantQuery	presentmentPrices(Storefront.ProductVariantPricePairConnectionQueryDefinition queryDef) List of prices and compare-at prices in the presentment currencies for this shop.
Storefront.ProductVariantQuery	presentmentPrices(Storefront.ProductVariantQuery.PresentmentPricesArgumentsDefinition argsDef, Storefront.ProductVariantPricePairConnectionQueryDefinition queryDef) List of prices and compare-at prices in the presentment currencies for this shop.
Storefront.ProductVariantQuery	presentmentUnitPrices(Storefront.MoneyV2ConnectionQueryDefinition queryDef) List of unit prices in the presentment currencies for this shop.
Storefront.ProductVariantQuery	presentmentUnitPrices(Storefront.ProductVariantQuery.PresentmentUnitPricesArgumentsDefinition argsDef, Storefront.MoneyV2ConnectionQueryDefinition queryDef) List of unit prices in the presentment currencies for this shop.
Storefront.ProductVariantQuery	price() Deprecated. Use `priceV2` instead
Storefront.ProductVariantQuery	priceV2(Storefront.MoneyV2QueryDefinition queryDef) The product variant’s price.
Storefront.ProductVariantQuery	product(Storefront.ProductQueryDefinition queryDef) The product object that the product variant belongs to.
Storefront.ProductVariantQuery	quantityAvailable() The total sellable quantity of the variant for online sales channels.
Storefront.ProductVariantQuery	requiresShipping() Whether a customer needs to provide a shipping address when placing an order for the product variant.
Storefront.ProductVariantQuery	selectedOptions(Storefront.SelectedOptionQueryDefinition queryDef) List of product options applied to the variant.
Storefront.ProductVariantQuery	sku() The SKU (stock keeping unit) associated with the variant.
Storefront.ProductVariantQuery	title() The product variant’s title.
Storefront.ProductVariantQuery	unitPrice(Storefront.MoneyV2QueryDefinition queryDef) The unit price value for the variant based on the variant's measurement.
Storefront.ProductVariantQuery	unitPriceMeasurement(Storefront.UnitPriceMeasurementQueryDefinition queryDef) The unit price measurement for the variant.
Storefront.ProductVariantQuery	weight() The weight of the product variant in the unit system specified with `weight_unit`.
Storefront.ProductVariantQuery	weightUnit() Unit of measurement for weight.

Methods inherited from class java.lang.Object

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

Method Detail

available

@Deprecated
public Storefront.ProductVariantQuery available()

Deprecated. Use `availableForSale` instead

Indicates if the product variant is in stock.

availableForSale

public Storefront.ProductVariantQuery availableForSale()

Indicates if the product variant is available for sale.

compareAtPrice

@Deprecated
public Storefront.ProductVariantQuery compareAtPrice()

Deprecated. Use `compareAtPriceV2` instead

The compare at price of the variant. This can be used to mark a variant as on sale, when `compareAtPrice` is higher than `price`.

compareAtPriceV2

public Storefront.ProductVariantQuery compareAtPriceV2(Storefront.MoneyV2QueryDefinition queryDef)

The compare at price of the variant. This can be used to mark a variant as on sale, when `compareAtPriceV2` is higher than `priceV2`.

currentlyNotInStock

public Storefront.ProductVariantQuery currentlyNotInStock()

Whether a product is out of stock but still available for purchase (used for backorders).

image

public Storefront.ProductVariantQuery image(Storefront.ImageQueryDefinition queryDef)

Image associated with the product variant. This field falls back to the product image if no image is available.

image

public Storefront.ProductVariantQuery image(Storefront.ProductVariantQuery.ImageArgumentsDefinition argsDef,
                                            Storefront.ImageQueryDefinition queryDef)

Image associated with the product variant. This field falls back to the product image if no image is available.

metafield

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

The metafield associated with the resource.

metafields

public Storefront.ProductVariantQuery metafields(Storefront.MetafieldConnectionQueryDefinition queryDef)

A paginated list of metafields associated with the resource.

metafields

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

A paginated list of metafields associated with the resource.

presentmentPrices

public Storefront.ProductVariantQuery presentmentPrices(Storefront.ProductVariantPricePairConnectionQueryDefinition queryDef)

List of prices and compare-at prices in the presentment currencies for this shop.

presentmentPrices

public Storefront.ProductVariantQuery presentmentPrices(Storefront.ProductVariantQuery.PresentmentPricesArgumentsDefinition argsDef,
                                                        Storefront.ProductVariantPricePairConnectionQueryDefinition queryDef)

List of prices and compare-at prices in the presentment currencies for this shop.

presentmentUnitPrices

public Storefront.ProductVariantQuery presentmentUnitPrices(Storefront.MoneyV2ConnectionQueryDefinition queryDef)

List of unit prices in the presentment currencies for this shop.

presentmentUnitPrices

public Storefront.ProductVariantQuery presentmentUnitPrices(Storefront.ProductVariantQuery.PresentmentUnitPricesArgumentsDefinition argsDef,
                                                            Storefront.MoneyV2ConnectionQueryDefinition queryDef)

List of unit prices in the presentment currencies for this shop.

price

@Deprecated
public Storefront.ProductVariantQuery price()

Deprecated. Use `priceV2` instead

The product variant’s price.

priceV2

public Storefront.ProductVariantQuery priceV2(Storefront.MoneyV2QueryDefinition queryDef)

The product variant’s price.

product

public Storefront.ProductVariantQuery product(Storefront.ProductQueryDefinition queryDef)

The product object that the product variant belongs to.

quantityAvailable

public Storefront.ProductVariantQuery quantityAvailable()

The total sellable quantity of the variant for online sales channels.

requiresShipping

public Storefront.ProductVariantQuery requiresShipping()

Whether a customer needs to provide a shipping address when placing an order for the product variant.

selectedOptions

public Storefront.ProductVariantQuery selectedOptions(Storefront.SelectedOptionQueryDefinition queryDef)

List of product options applied to the variant.

sku

public Storefront.ProductVariantQuery sku()

The SKU (stock keeping unit) associated with the variant.

title

public Storefront.ProductVariantQuery title()

The product variant’s title.

unitPrice

public Storefront.ProductVariantQuery unitPrice(Storefront.MoneyV2QueryDefinition queryDef)

The unit price value for the variant based on the variant's measurement.

unitPriceMeasurement

public Storefront.ProductVariantQuery unitPriceMeasurement(Storefront.UnitPriceMeasurementQueryDefinition queryDef)

The unit price measurement for the variant.

weight

public Storefront.ProductVariantQuery weight()

The weight of the product variant in the unit system specified with `weight_unit`.

weightUnit

public Storefront.ProductVariantQuery weightUnit()

Unit of measurement for weight.