com.shopify.buy3

Class Storefront.Product

java.lang.Object

<any>

com.shopify.buy3.Storefront.Product

All Implemented Interfaces:

Storefront.HasMetafields, Storefront.MetafieldParentResource, Storefront.Node

Enclosing class:

Storefront

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

A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty).

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getAvailableForSale() Indicates if at least one product variant is available for sale.
Storefront.CollectionConnection	getCollections() List of collections a product belongs to.
Storefront.ProductPriceRange	getCompareAtPriceRange() The compare at price of the product across all variants.
DateTime	getCreatedAt() The date and time when the product was created.
java.lang.String	getDescription() Stripped description of the product, single line with HTML tags removed.
java.lang.String	getDescriptionHtml() The description of the product, complete with HTML formatting.
java.lang.String	getGraphQlTypeName()
java.lang.String	getHandle() A human-friendly unique string for the Product automatically generated from its title.
ID	getId() Globally unique identifier.
Storefront.ImageConnection	getImages() List of images associated with the product.
Storefront.MediaConnection	getMedia() The media associated with the product.
Storefront.Metafield	getMetafield() The metafield associated with the resource.
Storefront.MetafieldConnection	getMetafields() A paginated list of metafields associated with the resource.
java.lang.String	getOnlineStoreUrl() The online store URL for the product.
java.util.List<Storefront.ProductOption>	getOptions() List of product options.
Storefront.ProductPriceRangeConnection	getPresentmentPriceRanges() List of price ranges in the presentment currencies for this shop.
Storefront.ProductPriceRange	getPriceRange() The price range.
java.lang.String	getProductType() A categorization that a product can be tagged with, commonly used for filtering and searching.
DateTime	getPublishedAt() The date and time when the product was published to the channel.
Storefront.SEO	getSeo() The product's SEO information.
java.util.List<java.lang.String>	getTags() A comma separated list of tags that have been added to the product.
java.lang.String	getTitle() The product’s title.
java.lang.Integer	getTotalInventory() The total quantity of inventory in stock for this Product.
DateTime	getUpdatedAt() The date and time when the product was last modified.
Storefront.ProductVariant	getVariantBySelectedOptions() Find a product’s variant based on its selected options.
Storefront.ProductVariantConnection	getVariants() List of the product’s variants.
java.lang.String	getVendor() The product’s vendor name.
Storefront.Product	setAvailableForSale(java.lang.Boolean arg)
Storefront.Product	setCollections(Storefront.CollectionConnection arg)
Storefront.Product	setCompareAtPriceRange(Storefront.ProductPriceRange arg)
Storefront.Product	setCreatedAt(DateTime arg)
Storefront.Product	setDescription(java.lang.String arg)
Storefront.Product	setDescriptionHtml(java.lang.String arg)
Storefront.Product	setHandle(java.lang.String arg)
Storefront.Product	setImages(Storefront.ImageConnection arg)
Storefront.Product	setMedia(Storefront.MediaConnection arg)
Storefront.Product	setMetafield(Storefront.Metafield arg)
Storefront.Product	setMetafields(Storefront.MetafieldConnection arg)
Storefront.Product	setOnlineStoreUrl(java.lang.String arg)
Storefront.Product	setOptions(java.util.List<Storefront.ProductOption> arg)
Storefront.Product	setPresentmentPriceRanges(Storefront.ProductPriceRangeConnection arg)
Storefront.Product	setPriceRange(Storefront.ProductPriceRange arg)
Storefront.Product	setProductType(java.lang.String arg)
Storefront.Product	setPublishedAt(DateTime arg)
Storefront.Product	setSeo(Storefront.SEO arg)
Storefront.Product	setTags(java.util.List<java.lang.String> arg)
Storefront.Product	setTitle(java.lang.String arg)
Storefront.Product	setTotalInventory(java.lang.Integer arg)
Storefront.Product	setUpdatedAt(DateTime arg)
Storefront.Product	setVariantBySelectedOptions(Storefront.ProductVariant arg)
Storefront.Product	setVariants(Storefront.ProductVariantConnection arg)
Storefront.Product	setVendor(java.lang.String 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

Product

public Product()

Product

public Product(JsonObject fields)
        throws SchemaViolationError

Throws:

SchemaViolationError

Product

public Product(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

getAvailableForSale

public java.lang.Boolean getAvailableForSale()

Indicates if at least one product variant is available for sale.

setAvailableForSale

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

getCollections

public Storefront.CollectionConnection getCollections()

List of collections a product belongs to.

setCollections

public Storefront.Product setCollections(Storefront.CollectionConnection arg)

getCompareAtPriceRange

public Storefront.ProductPriceRange getCompareAtPriceRange()

The compare at price of the product across all variants.

setCompareAtPriceRange

public Storefront.Product setCompareAtPriceRange(Storefront.ProductPriceRange arg)

getCreatedAt

public DateTime getCreatedAt()

The date and time when the product was created.

setCreatedAt

public Storefront.Product setCreatedAt(DateTime arg)

getDescription

public java.lang.String getDescription()

Stripped description of the product, single line with HTML tags removed.

setDescription

public Storefront.Product setDescription(java.lang.String arg)

getDescriptionHtml

public java.lang.String getDescriptionHtml()

The description of the product, complete with HTML formatting.

setDescriptionHtml

public Storefront.Product setDescriptionHtml(java.lang.String arg)

getHandle

public java.lang.String getHandle()

A human-friendly unique string for the Product automatically generated from its title. They are used by the Liquid templating language to refer to objects.

setHandle

public Storefront.Product setHandle(java.lang.String arg)

getId

public ID getId()

Globally unique identifier.

Specified by:

getId in interface Storefront.Node

getImages

public Storefront.ImageConnection getImages()

List of images associated with the product.

setImages

public Storefront.Product setImages(Storefront.ImageConnection arg)

getMedia

public Storefront.MediaConnection getMedia()

The media associated with the product.

setMedia

public Storefront.Product setMedia(Storefront.MediaConnection arg)

getMetafield

public Storefront.Metafield getMetafield()

The metafield associated with the resource.

Specified by:

getMetafield in interface Storefront.HasMetafields

setMetafield

public Storefront.Product 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.Product setMetafields(Storefront.MetafieldConnection arg)

getOnlineStoreUrl

public java.lang.String getOnlineStoreUrl()

The online store URL for the product. A value of `null` indicates that the product is not published to the Online Store sales channel.

setOnlineStoreUrl

public Storefront.Product setOnlineStoreUrl(java.lang.String arg)

getOptions

public java.util.List<Storefront.ProductOption> getOptions()

List of product options.

setOptions

public Storefront.Product setOptions(java.util.List<Storefront.ProductOption> arg)

getPresentmentPriceRanges

public Storefront.ProductPriceRangeConnection getPresentmentPriceRanges()

List of price ranges in the presentment currencies for this shop.

setPresentmentPriceRanges

public Storefront.Product setPresentmentPriceRanges(Storefront.ProductPriceRangeConnection arg)

getPriceRange

public Storefront.ProductPriceRange getPriceRange()

The price range.

setPriceRange

public Storefront.Product setPriceRange(Storefront.ProductPriceRange arg)

getProductType

public java.lang.String getProductType()

A categorization that a product can be tagged with, commonly used for filtering and searching.

setProductType

public Storefront.Product setProductType(java.lang.String arg)

getPublishedAt

public DateTime getPublishedAt()

The date and time when the product was published to the channel.

setPublishedAt

public Storefront.Product setPublishedAt(DateTime arg)

getSeo

public Storefront.SEO getSeo()

The product's SEO information.

setSeo

public Storefront.Product setSeo(Storefront.SEO arg)

getTags

public java.util.List<java.lang.String> getTags()

A comma separated list of tags that have been added to the product. Additional access scope required for private apps: unauthenticated_read_product_tags.

setTags

public Storefront.Product setTags(java.util.List<java.lang.String> arg)

getTitle

public java.lang.String getTitle()

The product’s title.

setTitle

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

getTotalInventory

public java.lang.Integer getTotalInventory()

The total quantity of inventory in stock for this Product.

setTotalInventory

public Storefront.Product setTotalInventory(java.lang.Integer arg)

getUpdatedAt

public DateTime getUpdatedAt()

The date and time when the product was last modified. A product's `updatedAt` value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update.

setUpdatedAt

public Storefront.Product setUpdatedAt(DateTime arg)

getVariantBySelectedOptions

public Storefront.ProductVariant getVariantBySelectedOptions()

Find a product’s variant based on its selected options. This is useful for converting a user’s selection of product options into a single matching variant. If there is not a variant for the selected options, `null` will be returned.

setVariantBySelectedOptions

public Storefront.Product setVariantBySelectedOptions(Storefront.ProductVariant arg)

getVariants

public Storefront.ProductVariantConnection getVariants()

List of the product’s variants.

setVariants

public Storefront.Product setVariants(Storefront.ProductVariantConnection arg)

getVendor

public java.lang.String getVendor()

The product’s vendor name.

setVendor

public Storefront.Product setVendor(java.lang.String arg)

unwrapsToObject

public boolean unwrapsToObject(java.lang.String key)