com.shopify.buy3

Class Storefront.ProductVariant

java.lang.Object

<any>

com.shopify.buy3.Storefront.ProductVariant

All Implemented Interfaces:

Storefront.HasMetafields, Storefront.MetafieldParentResource, Storefront.Node

Enclosing class:

Storefront

public static class Storefront.ProductVariant
extends <any>
implements Storefront.HasMetafields, Storefront.MetafieldParentResource, Storefront.Node

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

Constructor Summary

Constructors

Constructor and Description
ProductVariant()
ProductVariant(ID id)
ProductVariant(JsonObject fields)

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getAvailable() Deprecated. Use `availableForSale` instead
java.lang.Boolean	getAvailableForSale() Indicates if the product variant is available for sale.
java.math.BigDecimal	getCompareAtPrice() Deprecated. Use `compareAtPriceV2` instead
Storefront.MoneyV2	getCompareAtPriceV2() The compare at price of the variant.
java.lang.Boolean	getCurrentlyNotInStock() Whether a product is out of stock but still available for purchase (used for backorders).
java.lang.String	getGraphQlTypeName()
ID	getId() Globally unique identifier.
Storefront.Image	getImage() Image associated with the product variant.
Storefront.Metafield	getMetafield() The metafield associated with the resource.
Storefront.MetafieldConnection	getMetafields() A paginated list of metafields associated with the resource.
Storefront.ProductVariantPricePairConnection	getPresentmentPrices() List of prices and compare-at prices in the presentment currencies for this shop.
Storefront.MoneyV2Connection	getPresentmentUnitPrices() List of unit prices in the presentment currencies for this shop.
java.math.BigDecimal	getPrice() Deprecated. Use `priceV2` instead
Storefront.MoneyV2	getPriceV2() The product variant’s price.
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.
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.
java.lang.String	getSku() The SKU (stock keeping unit) associated with the variant.
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	setAvailable(java.lang.Boolean arg)
Storefront.ProductVariant	setAvailableForSale(java.lang.Boolean arg)
Storefront.ProductVariant	setCompareAtPrice(java.math.BigDecimal arg)
Storefront.ProductVariant	setCompareAtPriceV2(Storefront.MoneyV2 arg)
Storefront.ProductVariant	setCurrentlyNotInStock(java.lang.Boolean arg)
Storefront.ProductVariant	setImage(Storefront.Image arg)
Storefront.ProductVariant	setMetafield(Storefront.Metafield arg)
Storefront.ProductVariant	setMetafields(Storefront.MetafieldConnection arg)
Storefront.ProductVariant	setPresentmentPrices(Storefront.ProductVariantPricePairConnection arg)
Storefront.ProductVariant	setPresentmentUnitPrices(Storefront.MoneyV2Connection arg)
Storefront.ProductVariant	setPrice(java.math.BigDecimal arg)
Storefront.ProductVariant	setPriceV2(Storefront.MoneyV2 arg)
Storefront.ProductVariant	setProduct(Storefront.Product arg)
Storefront.ProductVariant	setQuantityAvailable(java.lang.Integer arg)
Storefront.ProductVariant	setRequiresShipping(java.lang.Boolean arg)
Storefront.ProductVariant	setSelectedOptions(java.util.List<Storefront.SelectedOption> arg)
Storefront.ProductVariant	setSku(java.lang.String 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 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

ProductVariant

public ProductVariant(ID id)

Method Detail

getGraphQlTypeName

public java.lang.String getGraphQlTypeName()

Specified by:

getGraphQlTypeName in interface Storefront.HasMetafields

Specified by:

getGraphQlTypeName in interface Storefront.MetafieldParentResource

Specified by:

getGraphQlTypeName in interface Storefront.Node

getAvailable

public java.lang.Boolean getAvailable()

Deprecated. Use `availableForSale` instead

Indicates if the product variant is in stock.

setAvailable

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

getAvailableForSale

public java.lang.Boolean getAvailableForSale()

Indicates if the product variant is available for sale.

setAvailableForSale

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

getCompareAtPrice

public java.math.BigDecimal getCompareAtPrice()

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`.

setCompareAtPrice

public Storefront.ProductVariant setCompareAtPrice(java.math.BigDecimal arg)

getCompareAtPriceV2

public Storefront.MoneyV2 getCompareAtPriceV2()

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)

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)

getId

public ID getId()

Globally unique identifier.

Specified by:

getId in interface Storefront.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()

The metafield associated with the resource.

Specified by:

getMetafield in interface Storefront.HasMetafields

setMetafield

public Storefront.ProductVariant setMetafield(Storefront.Metafield arg)

getMetafields

public Storefront.MetafieldConnection getMetafields()

A paginated list of metafields associated with the resource.

Specified by:

getMetafields in interface Storefront.HasMetafields

setMetafields

public Storefront.ProductVariant setMetafields(Storefront.MetafieldConnection arg)

getPresentmentPrices

public Storefront.ProductVariantPricePairConnection getPresentmentPrices()

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

setPresentmentPrices

public Storefront.ProductVariant setPresentmentPrices(Storefront.ProductVariantPricePairConnection arg)

getPresentmentUnitPrices

public Storefront.MoneyV2Connection getPresentmentUnitPrices()

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

setPresentmentUnitPrices

public Storefront.ProductVariant setPresentmentUnitPrices(Storefront.MoneyV2Connection arg)

getPrice

public java.math.BigDecimal getPrice()

Deprecated. Use `priceV2` instead

The product variant’s price.

setPrice

public Storefront.ProductVariant setPrice(java.math.BigDecimal arg)

getPriceV2

public Storefront.MoneyV2 getPriceV2()

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)

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)

getSku

public java.lang.String getSku()

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

setSku

public Storefront.ProductVariant setSku(java.lang.String 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)