com.shopify.buy3

Class Storefront.ProductVariantQuery

java.lang.Object

com.shopify.graphql.support.Query<Storefront.ProductVariantQuery>

com.shopify.buy3.Storefront.ProductVariantQuery

Enclosing class:

Storefront

public static class Storefront.ProductVariantQuery
extends Query<Storefront.ProductVariantQuery>

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.ComponentsArguments
static interface	Storefront.ProductVariantQuery.ComponentsArgumentsDefinition
class	Storefront.ProductVariantQuery.GroupedByArguments
static interface	Storefront.ProductVariantQuery.GroupedByArgumentsDefinition
class	Storefront.ProductVariantQuery.MetafieldArguments
static interface	Storefront.ProductVariantQuery.MetafieldArgumentsDefinition
class	Storefront.ProductVariantQuery.QuantityPriceBreaksArguments
static interface	Storefront.ProductVariantQuery.QuantityPriceBreaksArgumentsDefinition
class	Storefront.ProductVariantQuery.SellingPlanAllocationsArguments
static interface	Storefront.ProductVariantQuery.SellingPlanAllocationsArgumentsDefinition
class	Storefront.ProductVariantQuery.StoreAvailabilityArguments
static interface	Storefront.ProductVariantQuery.StoreAvailabilityArgumentsDefinition

Field Summary

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

_queryBuilder, ALIAS_SUFFIX_SEPARATOR

Method Summary

Modifier and Type	Method and Description
Storefront.ProductVariantQuery	availableForSale() Indicates if the product variant is available for sale.
Storefront.ProductVariantQuery	barcode() The barcode (for example, ISBN, UPC, or GTIN) associated with the variant.
Storefront.ProductVariantQuery	compareAtPrice(Storefront.MoneyV2QueryDefinition queryDef) The compare at price of the variant.
Storefront.ProductVariantQuery	compareAtPriceV2(Storefront.MoneyV2QueryDefinition queryDef) Deprecated. Use `compareAtPrice` instead.
Storefront.ProductVariantQuery	components(Storefront.ProductVariantComponentConnectionQueryDefinition queryDef) List of bundles components included in the variant considering only fixed bundles.
Storefront.ProductVariantQuery	components(Storefront.ProductVariantQuery.ComponentsArgumentsDefinition argsDef, Storefront.ProductVariantComponentConnectionQueryDefinition queryDef) List of bundles components included in the variant considering only fixed bundles.
Storefront.ProductVariantQuery	currentlyNotInStock() Whether a product is out of stock but still available for purchase (used for backorders).
Storefront.ProductVariantQuery	groupedBy(Storefront.ProductVariantConnectionQueryDefinition queryDef) List of bundles that include this variant considering only fixed bundles.
Storefront.ProductVariantQuery	groupedBy(Storefront.ProductVariantQuery.GroupedByArgumentsDefinition argsDef, Storefront.ProductVariantConnectionQueryDefinition queryDef) List of bundles that include this variant considering only fixed bundles.
Storefront.ProductVariantQuery	image(Storefront.ImageQueryDefinition queryDef) Image associated with the product variant.
Storefront.ProductVariantQuery	metafield(java.lang.String key, Storefront.MetafieldQueryDefinition queryDef) Returns a metafield found by namespace and key.
Storefront.ProductVariantQuery	metafield(java.lang.String key, Storefront.ProductVariantQuery.MetafieldArgumentsDefinition argsDef, Storefront.MetafieldQueryDefinition queryDef) Returns a metafield found by namespace and key.
Storefront.ProductVariantQuery	metafields(java.util.List<Storefront.HasMetafieldsIdentifier> identifiers, Storefront.MetafieldQueryDefinition queryDef) The metafields associated with the resource matching the supplied list of namespaces and keys.
Storefront.ProductVariantQuery	price(Storefront.MoneyV2QueryDefinition queryDef) The product variant’s price.
Storefront.ProductVariantQuery	priceV2(Storefront.MoneyV2QueryDefinition queryDef) Deprecated. Use `price` instead.
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	quantityPriceBreaks(Storefront.ProductVariantQuery.QuantityPriceBreaksArgumentsDefinition argsDef, Storefront.QuantityPriceBreakConnectionQueryDefinition queryDef) A list of quantity breaks for the product variant.
Storefront.ProductVariantQuery	quantityPriceBreaks(Storefront.QuantityPriceBreakConnectionQueryDefinition queryDef) A list of quantity breaks for the product variant.
Storefront.ProductVariantQuery	quantityRule(Storefront.QuantityRuleQueryDefinition queryDef) The quantity rule for the product variant in a given context.
Storefront.ProductVariantQuery	requiresComponents() Whether a product variant requires components.
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	sellingPlanAllocations(Storefront.ProductVariantQuery.SellingPlanAllocationsArgumentsDefinition argsDef, Storefront.SellingPlanAllocationConnectionQueryDefinition queryDef) Represents an association between a variant and a selling plan.
Storefront.ProductVariantQuery	sellingPlanAllocations(Storefront.SellingPlanAllocationConnectionQueryDefinition queryDef) Represents an association between a variant and a selling plan.
Storefront.ProductVariantQuery	sku() The SKU (stock keeping unit) associated with the variant.
Storefront.ProductVariantQuery	storeAvailability(Storefront.ProductVariantQuery.StoreAvailabilityArgumentsDefinition argsDef, Storefront.StoreAvailabilityConnectionQueryDefinition queryDef) The in-store pickup availability of this variant by location.
Storefront.ProductVariantQuery	storeAvailability(Storefront.StoreAvailabilityConnectionQueryDefinition queryDef) The in-store pickup availability of this variant by location.
Storefront.ProductVariantQuery	taxable() Whether tax is charged when the product variant is sold.
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 com.shopify.graphql.support.Query

appendQuotedString, startField, startInlineFragment, withAlias

Methods inherited from class java.lang.Object

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

Method Detail

availableForSale

public Storefront.ProductVariantQuery availableForSale()

Indicates if the product variant is available for sale.

barcode

public Storefront.ProductVariantQuery barcode()

The barcode (for example, ISBN, UPC, or GTIN) associated with the variant.

compareAtPrice

public Storefront.ProductVariantQuery compareAtPrice(Storefront.MoneyV2QueryDefinition queryDef)

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

@Deprecated
public Storefront.ProductVariantQuery compareAtPriceV2(Storefront.MoneyV2QueryDefinition queryDef)

Deprecated. Use `compareAtPrice` instead.

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

components

public Storefront.ProductVariantQuery components(Storefront.ProductVariantComponentConnectionQueryDefinition queryDef)

List of bundles components included in the variant considering only fixed bundles.

components

public Storefront.ProductVariantQuery components(Storefront.ProductVariantQuery.ComponentsArgumentsDefinition argsDef,
                                                 Storefront.ProductVariantComponentConnectionQueryDefinition queryDef)

List of bundles components included in the variant considering only fixed bundles.

currentlyNotInStock

public Storefront.ProductVariantQuery currentlyNotInStock()

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

groupedBy

public Storefront.ProductVariantQuery groupedBy(Storefront.ProductVariantConnectionQueryDefinition queryDef)

List of bundles that include this variant considering only fixed bundles.

groupedBy

public Storefront.ProductVariantQuery groupedBy(Storefront.ProductVariantQuery.GroupedByArgumentsDefinition argsDef,
                                                Storefront.ProductVariantConnectionQueryDefinition queryDef)

List of bundles that include this variant considering only fixed bundles.

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.

metafield

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

Returns a metafield found by namespace and key.

metafield

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

Returns a metafield found by namespace and key.

metafields

public Storefront.ProductVariantQuery metafields(java.util.List<Storefront.HasMetafieldsIdentifier> identifiers,
                                                 Storefront.MetafieldQueryDefinition queryDef)

The metafields associated with the resource matching the supplied list of namespaces and keys.

price

public Storefront.ProductVariantQuery price(Storefront.MoneyV2QueryDefinition queryDef)

The product variant’s price.

priceV2

@Deprecated
public Storefront.ProductVariantQuery priceV2(Storefront.MoneyV2QueryDefinition queryDef)

Deprecated. Use `price` instead.

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.

quantityPriceBreaks

public Storefront.ProductVariantQuery quantityPriceBreaks(Storefront.QuantityPriceBreakConnectionQueryDefinition queryDef)

A list of quantity breaks for the product variant.

quantityPriceBreaks

public Storefront.ProductVariantQuery quantityPriceBreaks(Storefront.ProductVariantQuery.QuantityPriceBreaksArgumentsDefinition argsDef,
                                                          Storefront.QuantityPriceBreakConnectionQueryDefinition queryDef)

A list of quantity breaks for the product variant.

quantityRule

public Storefront.ProductVariantQuery quantityRule(Storefront.QuantityRuleQueryDefinition queryDef)

The quantity rule for the product variant in a given context.

requiresComponents

public Storefront.ProductVariantQuery requiresComponents()

Whether a product variant requires components. The default value is `false`. If `true`, then the product variant can only be purchased as a parent bundle with components.

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.

sellingPlanAllocations

public Storefront.ProductVariantQuery sellingPlanAllocations(Storefront.SellingPlanAllocationConnectionQueryDefinition queryDef)

Represents an association between a variant and a selling plan. Selling plan allocations describe which selling plans are available for each variant, and what their impact is on pricing.

sellingPlanAllocations

public Storefront.ProductVariantQuery sellingPlanAllocations(Storefront.ProductVariantQuery.SellingPlanAllocationsArgumentsDefinition argsDef,
                                                             Storefront.SellingPlanAllocationConnectionQueryDefinition queryDef)

Represents an association between a variant and a selling plan. Selling plan allocations describe which selling plans are available for each variant, and what their impact is on pricing.

sku

public Storefront.ProductVariantQuery sku()

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

storeAvailability

public Storefront.ProductVariantQuery storeAvailability(Storefront.StoreAvailabilityConnectionQueryDefinition queryDef)

The in-store pickup availability of this variant by location.

storeAvailability

public Storefront.ProductVariantQuery storeAvailability(Storefront.ProductVariantQuery.StoreAvailabilityArgumentsDefinition argsDef,
                                                        Storefront.StoreAvailabilityConnectionQueryDefinition queryDef)

The in-store pickup availability of this variant by location.

taxable

public Storefront.ProductVariantQuery taxable()

Whether tax is charged when the product variant is sold.

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.