Storefront.ProductVariant (buy3 18.0.0 API)

java.lang.Object
- com.shopify.graphql.support.AbstractResponse<Storefront.ProductVariant>
- - com.shopify.buy3.Storefront.ProductVariant

All Implemented Interfaces:

Storefront.HasMetafields, Storefront.Merchandise, Storefront.MetafieldParentResource, Storefront.MetafieldReference, Storefront.Node, Node, java.io.Serializable

Enclosing class:

Storefront
```
public static class Storefront.ProductVariant
extends AbstractResponse<Storefront.ProductVariant>
implements Storefront.HasMetafields, Storefront.Merchandise, Storefront.MetafieldParentResource, Storefront.MetafieldReference, Storefront.Node
```
A product variant represents a different version of a product, such as differing sizes or differing colors.

See Also:

Serialized Form

Field Summary
- Fields inherited from class com.shopify.graphql.support.AbstractResponse
  optimisticData, responseData

Constructor Summary

Constructors
Constructor and Description

ProductVariant()

ProductVariant(JsonObject fields)

Constructors
Constructor and Description
`ProductVariant()`
`ProductVariant(JsonObject fields)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.Boolean`	`getAvailableForSale()` Indicates if the product variant is available for sale.
`java.lang.String`	`getBarcode()` The barcode (for example, ISBN, UPC, or GTIN) associated with the variant.
`Storefront.MoneyV2`	`getCompareAtPrice()` The compare at price of the variant.
`Storefront.MoneyV2`	`getCompareAtPriceV2()` Deprecated. Use `compareAtPrice` instead.
`Storefront.ProductVariantComponentConnection`	`getComponents()` List of bundles components included in the variant considering only fixed bundles.
`java.lang.Boolean`	`getCurrentlyNotInStock()` Whether a product is out of stock but still available for purchase (used for backorders).
`java.lang.String`	`getGraphQlTypeName()`
`Storefront.ProductVariantConnection`	`getGroupedBy()` List of bundles that include this variant considering only fixed bundles.
`ID`	`getId()` A globally-unique ID.
`Storefront.Image`	`getImage()` Image associated with the product variant.
`Storefront.Metafield`	`getMetafield()` Returns a metafield found by namespace and key.
`java.util.List<Storefront.Metafield>`	`getMetafields()` The metafields associated with the resource matching the supplied list of namespaces and keys.
`Storefront.MoneyV2`	`getPrice()` The product variant’s price.
`Storefront.MoneyV2`	`getPriceV2()` Deprecated. Use `price` instead.
`Storefront.Product`	`getProduct()` The product object that the product variant belongs to.
`java.lang.Integer`	`getQuantityAvailable()` The total sellable quantity of the variant for online sales channels.
`Storefront.QuantityPriceBreakConnection`	`getQuantityPriceBreaks()` A list of quantity breaks for the product variant.
`Storefront.QuantityRule`	`getQuantityRule()` The quantity rule for the product variant in a given context.
`java.lang.Boolean`	`getRequiresComponents()` Whether a product variant requires components.
`java.lang.Boolean`	`getRequiresShipping()` Whether a customer needs to provide a shipping address when placing an order for the product variant.
`java.util.List<Storefront.SelectedOption>`	`getSelectedOptions()` List of product options applied to the variant.
`Storefront.SellingPlanAllocationConnection`	`getSellingPlanAllocations()` Represents an association between a variant and a selling plan.
`java.lang.String`	`getSku()` The SKU (stock keeping unit) associated with the variant.
`Storefront.StoreAvailabilityConnection`	`getStoreAvailability()` The in-store pickup availability of this variant by location.
`java.lang.Boolean`	`getTaxable()` Whether tax is charged when the product variant is sold.
`java.lang.String`	`getTitle()` The product variant’s title.
`Storefront.MoneyV2`	`getUnitPrice()` The unit price value for the variant based on the variant's measurement.
`Storefront.UnitPriceMeasurement`	`getUnitPriceMeasurement()` The unit price measurement for the variant.
`java.lang.Double`	`getWeight()` The weight of the product variant in the unit system specified with `weight_unit`.
`Storefront.WeightUnit`	`getWeightUnit()` Unit of measurement for weight.
`Storefront.ProductVariant`	`setAvailableForSale(java.lang.Boolean arg)`
`Storefront.ProductVariant`	`setBarcode(java.lang.String arg)`
`Storefront.ProductVariant`	`setCompareAtPrice(Storefront.MoneyV2 arg)`
`Storefront.ProductVariant`	`setCompareAtPriceV2(Storefront.MoneyV2 arg)`
`Storefront.ProductVariant`	`setComponents(Storefront.ProductVariantComponentConnection arg)`
`Storefront.ProductVariant`	`setCurrentlyNotInStock(java.lang.Boolean arg)`
`Storefront.ProductVariant`	`setGroupedBy(Storefront.ProductVariantConnection arg)`
`Storefront.ProductVariant`	`setImage(Storefront.Image arg)`
`Storefront.ProductVariant`	`setMetafield(Storefront.Metafield arg)`
`Storefront.ProductVariant`	`setMetafields(java.util.List<Storefront.Metafield> arg)`
`Storefront.ProductVariant`	`setPrice(Storefront.MoneyV2 arg)`
`Storefront.ProductVariant`	`setPriceV2(Storefront.MoneyV2 arg)`
`Storefront.ProductVariant`	`setProduct(Storefront.Product arg)`
`Storefront.ProductVariant`	`setQuantityAvailable(java.lang.Integer arg)`
`Storefront.ProductVariant`	`setQuantityPriceBreaks(Storefront.QuantityPriceBreakConnection arg)`
`Storefront.ProductVariant`	`setQuantityRule(Storefront.QuantityRule arg)`
`Storefront.ProductVariant`	`setRequiresComponents(java.lang.Boolean arg)`
`Storefront.ProductVariant`	`setRequiresShipping(java.lang.Boolean arg)`
`Storefront.ProductVariant`	`setSelectedOptions(java.util.List<Storefront.SelectedOption> arg)`
`Storefront.ProductVariant`	`setSellingPlanAllocations(Storefront.SellingPlanAllocationConnection arg)`
`Storefront.ProductVariant`	`setSku(java.lang.String arg)`
`Storefront.ProductVariant`	`setStoreAvailability(Storefront.StoreAvailabilityConnection arg)`
`Storefront.ProductVariant`	`setTaxable(java.lang.Boolean arg)`
`Storefront.ProductVariant`	`setTitle(java.lang.String arg)`
`Storefront.ProductVariant`	`setUnitPrice(Storefront.MoneyV2 arg)`
`Storefront.ProductVariant`	`setUnitPriceMeasurement(Storefront.UnitPriceMeasurement arg)`
`Storefront.ProductVariant`	`setWeight(java.lang.Double arg)`
`Storefront.ProductVariant`	`setWeightUnit(Storefront.WeightUnit arg)`
`boolean`	`unwrapsToObject(java.lang.String key)`

Methods inherited from class com.shopify.graphql.support.AbstractResponse
collectNodes, get, getFieldName, getKey, jsonAsArray, jsonAsBoolean, jsonAsDouble, jsonAsInteger, jsonAsObject, jsonAsString, withAlias

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProductVariant
```
public ProductVariant()
```

ProductVariant

public ProductVariant(JsonObject fields)
               throws SchemaViolationError

Throws:: SchemaViolationError

Method Detail

getGraphQlTypeName
```
public java.lang.String getGraphQlTypeName()
```
Specified by:

getGraphQlTypeName in interface Storefront.HasMetafields

Specified by:

getGraphQlTypeName in interface Storefront.Merchandise

Specified by:

getGraphQlTypeName in interface Storefront.MetafieldParentResource

Specified by:

getGraphQlTypeName in interface Storefront.MetafieldReference

Specified by:

getGraphQlTypeName in interface Storefront.Node

Specified by:

getGraphQlTypeName in interface Node

getAvailableForSale
```
public java.lang.Boolean getAvailableForSale()
```
Indicates if the product variant is available for sale.

setAvailableForSale

public Storefront.ProductVariant setAvailableForSale(java.lang.Boolean arg)

getBarcode
```
public java.lang.String getBarcode()
```
The barcode (for example, ISBN, UPC, or GTIN) associated with the variant.

setBarcode

public Storefront.ProductVariant setBarcode(java.lang.String arg)

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

setCompareAtPrice

public Storefront.ProductVariant setCompareAtPrice(Storefront.MoneyV2 arg)

getCompareAtPriceV2
```
public Storefront.MoneyV2 getCompareAtPriceV2()
```
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`.

setCompareAtPriceV2

public Storefront.ProductVariant setCompareAtPriceV2(Storefront.MoneyV2 arg)

getComponents
```
public Storefront.ProductVariantComponentConnection getComponents()
```
List of bundles components included in the variant considering only fixed bundles.

setComponents

public Storefront.ProductVariant setComponents(Storefront.ProductVariantComponentConnection arg)

getCurrentlyNotInStock
```
public java.lang.Boolean getCurrentlyNotInStock()
```
Whether a product is out of stock but still available for purchase (used for backorders).

setCurrentlyNotInStock

public Storefront.ProductVariant setCurrentlyNotInStock(java.lang.Boolean arg)

getGroupedBy
```
public Storefront.ProductVariantConnection getGroupedBy()
```
List of bundles that include this variant considering only fixed bundles.

setGroupedBy

public Storefront.ProductVariant setGroupedBy(Storefront.ProductVariantConnection arg)

getId
```
public ID getId()
```
A globally-unique ID.

Specified by:

getId in interface Storefront.Node

Specified by:

getId in interface Node

getImage
```
public Storefront.Image getImage()
```
Image associated with the product variant. This field falls back to the product image if no image is available.

setImage

public Storefront.ProductVariant setImage(Storefront.Image arg)

getMetafield
```
public Storefront.Metafield getMetafield()
```
Returns a metafield found by namespace and key.

Specified by:

getMetafield in interface Storefront.HasMetafields

setMetafield

public Storefront.ProductVariant setMetafield(Storefront.Metafield arg)

getMetafields
```
public java.util.List<Storefront.Metafield> getMetafields()
```
The metafields associated with the resource matching the supplied list of namespaces and keys.

Specified by:

getMetafields in interface Storefront.HasMetafields

setMetafields

public Storefront.ProductVariant setMetafields(java.util.List<Storefront.Metafield> arg)

getPrice
```
public Storefront.MoneyV2 getPrice()
```
The product variant’s price.

setPrice

public Storefront.ProductVariant setPrice(Storefront.MoneyV2 arg)

getPriceV2
```
public Storefront.MoneyV2 getPriceV2()
```
Deprecated. Use `price` instead.

The product variant’s price.

setPriceV2

public Storefront.ProductVariant setPriceV2(Storefront.MoneyV2 arg)

getProduct
```
public Storefront.Product getProduct()
```
The product object that the product variant belongs to.

setProduct

public Storefront.ProductVariant setProduct(Storefront.Product arg)

getQuantityAvailable
```
public java.lang.Integer getQuantityAvailable()
```
The total sellable quantity of the variant for online sales channels.

setQuantityAvailable

public Storefront.ProductVariant setQuantityAvailable(java.lang.Integer arg)

getQuantityPriceBreaks

public Storefront.QuantityPriceBreakConnection getQuantityPriceBreaks()

A list of quantity breaks for the product variant.

setQuantityPriceBreaks

public Storefront.ProductVariant setQuantityPriceBreaks(Storefront.QuantityPriceBreakConnection arg)

getQuantityRule
```
public Storefront.QuantityRule getQuantityRule()
```
The quantity rule for the product variant in a given context.

setQuantityRule

public Storefront.ProductVariant setQuantityRule(Storefront.QuantityRule arg)

getRequiresComponents
```
public java.lang.Boolean getRequiresComponents()
```
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.

setRequiresComponents

public Storefront.ProductVariant setRequiresComponents(java.lang.Boolean arg)

getRequiresShipping
```
public java.lang.Boolean getRequiresShipping()
```
Whether a customer needs to provide a shipping address when placing an order for the product variant.

setRequiresShipping

public Storefront.ProductVariant setRequiresShipping(java.lang.Boolean arg)

getSelectedOptions

public java.util.List<Storefront.SelectedOption> getSelectedOptions()

List of product options applied to the variant.

setSelectedOptions

public Storefront.ProductVariant setSelectedOptions(java.util.List<Storefront.SelectedOption> arg)

getSellingPlanAllocations
```
public Storefront.SellingPlanAllocationConnection getSellingPlanAllocations()
```
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.

setSellingPlanAllocations

public Storefront.ProductVariant setSellingPlanAllocations(Storefront.SellingPlanAllocationConnection arg)

getSku
```
public java.lang.String getSku()
```
The SKU (stock keeping unit) associated with the variant.

setSku

public Storefront.ProductVariant setSku(java.lang.String arg)

getStoreAvailability
```
public Storefront.StoreAvailabilityConnection getStoreAvailability()
```
The in-store pickup availability of this variant by location.

setStoreAvailability

public Storefront.ProductVariant setStoreAvailability(Storefront.StoreAvailabilityConnection arg)

getTaxable
```
public java.lang.Boolean getTaxable()
```
Whether tax is charged when the product variant is sold.

setTaxable

public Storefront.ProductVariant setTaxable(java.lang.Boolean arg)

getTitle
```
public java.lang.String getTitle()
```
The product variant’s title.

setTitle

public Storefront.ProductVariant setTitle(java.lang.String arg)

getUnitPrice
```
public Storefront.MoneyV2 getUnitPrice()
```
The unit price value for the variant based on the variant's measurement.

setUnitPrice

public Storefront.ProductVariant setUnitPrice(Storefront.MoneyV2 arg)

getUnitPriceMeasurement

public Storefront.UnitPriceMeasurement getUnitPriceMeasurement()

The unit price measurement for the variant.

setUnitPriceMeasurement

public Storefront.ProductVariant setUnitPriceMeasurement(Storefront.UnitPriceMeasurement arg)

getWeight
```
public java.lang.Double getWeight()
```
The weight of the product variant in the unit system specified with `weight_unit`.

setWeight

public Storefront.ProductVariant setWeight(java.lang.Double arg)

getWeightUnit

public Storefront.WeightUnit getWeightUnit()

Unit of measurement for weight.

setWeightUnit

public Storefront.ProductVariant setWeightUnit(Storefront.WeightUnit arg)

unwrapsToObject
```
public boolean unwrapsToObject(java.lang.String key)
```
Specified by:

unwrapsToObject in class AbstractResponse<Storefront.ProductVariant>

Class Storefront.ProductVariant

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class com.shopify.graphql.support.AbstractResponse

Methods inherited from class java.lang.Object

Constructor Detail

ProductVariant

ProductVariant

Method Detail

getGraphQlTypeName

getAvailableForSale

setAvailableForSale

getBarcode

setBarcode

getCompareAtPrice

setCompareAtPrice

getCompareAtPriceV2

setCompareAtPriceV2

getComponents

setComponents

getCurrentlyNotInStock

setCurrentlyNotInStock

getGroupedBy

setGroupedBy

getId

getImage

setImage

getMetafield

setMetafield

getMetafields

setMetafields

getPrice

setPrice

getPriceV2

setPriceV2

getProduct

setProduct

getQuantityAvailable

setQuantityAvailable

getQuantityPriceBreaks

setQuantityPriceBreaks

getQuantityRule

setQuantityRule

getRequiresComponents

setRequiresComponents

getRequiresShipping

setRequiresShipping

getSelectedOptions

setSelectedOptions

getSellingPlanAllocations

setSellingPlanAllocations

getSku

setSku

getStoreAvailability

setStoreAvailability

getTaxable

setTaxable

getTitle

setTitle

getUnitPrice

setUnitPrice

getUnitPriceMeasurement

setUnitPriceMeasurement

getWeight

setWeight

getWeightUnit

setWeightUnit

unwrapsToObject