io.sphere.sdk.products

Interface ProductVariant

All Superinterfaces:

AttributeContainer

public interface ProductVariant
extends AttributeContainer

Method Summary

Modifier and Type	Method and Description
List<Asset>	getAssets()
ProductVariantAvailability	getAvailability() The availability is set if the variant is tracked by the inventory.
Integer	getId()
ByIdVariantIdentifier	getIdentifier() Gets the id of the product and the variant.
List<Image>	getImages() Product images
String	getKey() Key of the variant.
Price	getPrice() Optional price from the price selection in the search endpoint.
List<Price>	getPrices() Gets all prices for this product variant.
ScopedPrice	getScopedPrice() Optional price from the price scoped filtering in the search endpoint.
String	getSku()
Boolean	isMatchingVariant() A flag that indicates whether the variant matches the search criteria used when requesting the list of products or not.
Boolean	isScopedPriceDiscounted() Flag if scoped price is discounted.

Methods inherited from interface io.sphere.sdk.products.AttributeContainer

findAttribute, findAttribute, findAttribute, getAttribute, getAttributes, hasAttribute, hasAttribute, of

Method Detail

getId

Integer getId()

getSku

@Nullable
String getSku()

getPrices

List<Price> getPrices()

Gets all prices for this product variant. For a price matching a currency/country/channel/customer group context consider the use of ProductProjectionSearch with ProductProjectionSearch.withPriceSelection(PriceSelection).

Returns:

prices

See Also:

getPrice(), getScopedPrice()

getPrice

@Nullable
Price getPrice()

Optional price from the price selection in the search endpoint. By default this price is null but it can be filled by using ProductProjectionSearch.withPriceSelection(PriceSelection).

Returns:

selected price or null

See Also:

getPrices(), getScopedPrice()

getScopedPrice

@Nullable
ScopedPrice getScopedPrice()

Optional price from the price scoped filtering in the search endpoint. By default this price is null but it can be filled by using ProductVariantFilterSearchModel.scopedPrice().

Returns:

scoped price or null

See Also:

getPrices(), getPrice()

isScopedPriceDiscounted

@Nullable
Boolean isScopedPriceDiscounted()

Flag if scoped price is discounted. By default this flag is null but it can be filled by using ProductVariantFilterSearchModel.scopedPrice().

Returns:

getImages

List<Image> getImages()

Product images

Returns:

Images

See Also:

MoveImageToPosition, AddExternalImage, RemoveImage

getAvailability

@Nullable
ProductVariantAvailability getAvailability()

The availability is set if the variant is tracked by the inventory. The field might not contain the latest inventory state (it is eventually consistent) and can be used as an optimization to reduce calls to the inventory service.

Returns:

availability

isMatchingVariant

@Nullable
Boolean isMatchingVariant()

A flag that indicates whether the variant matches the search criteria used when requesting the list of products or not. This flag is needed since all products that have at least one matching variant will be returned, along with all its variants, even those that do not match the search request themselves. Notice that this flag is only set when using the ProductProjection Search endpoint.

Returns:

whether the variant matches the search request parameters

getIdentifier

@Nullable
ByIdVariantIdentifier getIdentifier()

Gets the id of the product and the variant. This operation may not be available. It will be available if this ProductVariant has been created by loading a Product or a ProductProjection from JSON.

Returns:

identifier for this variant

Throws:

UnsupportedOperationException - if the operation is not available

getKey

@Nullable
String getKey()

Key of the variant.

Returns:

key

See Also:

SetProductVariantKey

getAssets

@Nonnull
List<Asset> getAssets()