Storefront.Product (buy3 18.0.0 API)

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

All Implemented Interfaces:

Storefront.HasMetafields, Storefront.MenuItemResource, Storefront.MetafieldParentResource, Storefront.MetafieldReference, Storefront.Node, Storefront.OnlineStorePublishable, Storefront.SearchResultItem, Storefront.Trackable, Node, java.io.Serializable

Enclosing class:

Storefront
```
public static class Storefront.Product
extends AbstractResponse<Storefront.Product>
implements Storefront.HasMetafields, Storefront.MenuItemResource, Storefront.MetafieldParentResource, Storefront.MetafieldReference, Storefront.Node, Storefront.OnlineStorePublishable, Storefront.SearchResultItem, Storefront.Trackable
```
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).

See Also:

Serialized Form

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

Constructor Summary

Constructors
Constructor and Description

Product()

Product(JsonObject fields)

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

Method Summary

All Methods Instance Methods Concrete Methods
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.
`Storefront.Image`	`getFeaturedImage()` The featured image for the product.
`java.lang.String`	`getGraphQlTypeName()`
`java.lang.String`	`getHandle()` A human-friendly unique string for the Product automatically generated from its title.
`ID`	`getId()` A globally-unique ID.
`Storefront.ImageConnection`	`getImages()` List of images associated with the product.
`java.lang.Boolean`	`getIsGiftCard()` Whether the product is a gift card.
`Storefront.MediaConnection`	`getMedia()` The media associated with the product.
`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.
`java.lang.String`	`getOnlineStoreUrl()` The URL used for viewing the resource on the shop's Online Store.
`java.util.List<Storefront.ProductOption>`	`getOptions()` List of product options.
`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.
`java.lang.Boolean`	`getRequiresSellingPlan()` Whether the product can only be purchased with a selling plan.
`Storefront.SellingPlanGroupConnection`	`getSellingPlanGroups()` A list of a product's available selling plan groups.
`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.
`java.lang.String`	`getTrackingParameters()` A URL parameters to be added to a page URL when it is linked from a GraphQL result.
`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`	`setFeaturedImage(Storefront.Image arg)`
`Storefront.Product`	`setHandle(java.lang.String arg)`
`Storefront.Product`	`setImages(Storefront.ImageConnection arg)`
`Storefront.Product`	`setIsGiftCard(java.lang.Boolean arg)`
`Storefront.Product`	`setMedia(Storefront.MediaConnection arg)`
`Storefront.Product`	`setMetafield(Storefront.Metafield arg)`
`Storefront.Product`	`setMetafields(java.util.List<Storefront.Metafield> arg)`
`Storefront.Product`	`setOnlineStoreUrl(java.lang.String arg)`
`Storefront.Product`	`setOptions(java.util.List<Storefront.ProductOption> arg)`
`Storefront.Product`	`setPriceRange(Storefront.ProductPriceRange arg)`
`Storefront.Product`	`setProductType(java.lang.String arg)`
`Storefront.Product`	`setPublishedAt(DateTime arg)`
`Storefront.Product`	`setRequiresSellingPlan(java.lang.Boolean arg)`
`Storefront.Product`	`setSellingPlanGroups(Storefront.SellingPlanGroupConnection 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`	`setTrackingParameters(java.lang.String 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 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
  - Product
```
public Product()
```
  - Product
```
public Product(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.MenuItemResource
    
    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 Storefront.OnlineStorePublishable
    
    Specified by:
    
    getGraphQlTypeName in interface Storefront.SearchResultItem
    
    Specified by:
    
    getGraphQlTypeName in interface Storefront.Trackable
    
    Specified by:
    
    getGraphQlTypeName in interface 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)
```
  - getFeaturedImage
```
public Storefront.Image getFeaturedImage()
```
    The featured image for the product. This field is functionally equivalent to `images(first: 1)`.
  - setFeaturedImage
```
public Storefront.Product setFeaturedImage(Storefront.Image 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()
```
    A globally-unique ID.
    
    Specified by:
    
    getId in interface Storefront.Node
    
    Specified by:
    
    getId in interface Node
  - getImages
```
public Storefront.ImageConnection getImages()
```
    List of images associated with the product.
  - setImages
```
public Storefront.Product setImages(Storefront.ImageConnection arg)
```
  - getIsGiftCard
```
public java.lang.Boolean getIsGiftCard()
```
    Whether the product is a gift card.
  - setIsGiftCard
```
public Storefront.Product setIsGiftCard(java.lang.Boolean 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()
```
    Returns a metafield found by namespace and key.
    
    Specified by:
    
    getMetafield in interface Storefront.HasMetafields
  - setMetafield
```
public Storefront.Product 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.Product setMetafields(java.util.List<Storefront.Metafield> arg)
```
  - getOnlineStoreUrl
```
public java.lang.String getOnlineStoreUrl()
```
    The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel.
    
    Specified by:
    
    getOnlineStoreUrl in interface Storefront.OnlineStorePublishable
  - 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)
```
  - 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)
```
  - getRequiresSellingPlan
```
public java.lang.Boolean getRequiresSellingPlan()
```
    Whether the product can only be purchased with a selling plan.
  - setRequiresSellingPlan
```
public Storefront.Product setRequiresSellingPlan(java.lang.Boolean arg)
```
  - getSellingPlanGroups
```
public Storefront.SellingPlanGroupConnection getSellingPlanGroups()
```
    A list of a product's available selling plan groups. A selling plan group represents a selling method. For example, 'Subscribe and save' is a selling method where customers pay for goods or services per delivery. A selling plan group contains individual selling plans.
  - setSellingPlanGroups
```
public Storefront.Product setSellingPlanGroups(Storefront.SellingPlanGroupConnection 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)
```
  - getTrackingParameters
```
public java.lang.String getTrackingParameters()
```
    A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic.
    
    Specified by:
    
    getTrackingParameters in interface Storefront.Trackable
  - setTrackingParameters
```
public Storefront.Product setTrackingParameters(java.lang.String 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)
```
    Specified by:
    
    unwrapsToObject in class AbstractResponse<Storefront.Product>

Class Storefront.Product

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

Product

Product

Method Detail

getGraphQlTypeName

getAvailableForSale

setAvailableForSale

getCollections

setCollections

getCompareAtPriceRange

setCompareAtPriceRange

getCreatedAt

setCreatedAt

getDescription

setDescription

getDescriptionHtml

setDescriptionHtml

getFeaturedImage

setFeaturedImage

getHandle

setHandle

getId

getImages

setImages

getIsGiftCard

setIsGiftCard

getMedia

setMedia

getMetafield

setMetafield

getMetafields

setMetafields

getOnlineStoreUrl

setOnlineStoreUrl

getOptions

setOptions

getPriceRange

setPriceRange

getProductType

setProductType

getPublishedAt

setPublishedAt

getRequiresSellingPlan

setRequiresSellingPlan

getSellingPlanGroups

setSellingPlanGroups

getSeo

setSeo

getTags

setTags

getTitle

setTitle

getTotalInventory

setTotalInventory

getTrackingParameters

setTrackingParameters

getUpdatedAt

setUpdatedAt

getVariantBySelectedOptions

setVariantBySelectedOptions

getVariants

setVariants

getVendor

setVendor

unwrapsToObject