ProductInterface (Magento GraphQL data models and query builders 9.1.0-magento242ee API)

All Superinterfaces:

CustomFieldInterface

All Known Implementing Classes:

BundleProduct, ConfigurableProduct, DownloadableProduct, GiftCardProduct, GroupedProduct, SimpleProduct, UnknownProductInterface, VirtualProduct
```
public interface ProductInterface
extends CustomFieldInterface
```
The ProductInterface contains attributes that are common to all types of products. Note that descriptions may not be available for custom and EAV attributes.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`Integer`	`getAttributeSetId()` Deprecated. The field should not be used on the storefront.
`String`	`getCanonicalUrl()` Relative canonical URL.
`List<CategoryInterface>`	`getCategories()` The categories assigned to a product.
`Integer`	`getColor()`
`String`	`getCountryOfManufacture()` The product's country of origin.
`String`	`getCreatedAt()` Deprecated. The field should not be used on the storefront.
`List<ProductInterface>`	`getCrosssellProducts()` Crosssell Products
`ComplexTextValue`	`getDescription()` Detailed information about the product.
`String`	`getGiftMessageAvailable()` Indicates whether a gift message is available.
`String`	`getGraphQlTypeName()`
`Integer`	`getId()` Deprecated. Use the `uid` field instead.
`ProductImage`	`getImage()` The relative path to the main image on the product page.
`String`	`getIsReturnable()` Indicates whether the product can be returned
`Integer`	`getManufacturer()` A number representing the product's manufacturer.
`List<MediaGalleryInterface>`	`getMediaGallery()` An array of Media Gallery objects.
`List<MediaGalleryEntry>`	`getMediaGalleryEntries()` Deprecated. Use product's `media_gallery` instead
`String`	`getMetaDescription()` A brief overview of the product for search results listings, maximum 255 characters.
`String`	`getMetaKeyword()` A comma-separated list of keywords that are visible only to search engines.
`String`	`getMetaTitle()` A string that is displayed in the title bar and tab of the browser and in search results lists.
`String`	`getName()` The product name.
`String`	`getNewFromDate()` Deprecated. The field should not be used on the storefront.
`String`	`getNewToDate()` Deprecated. The field should not be used on the storefront.
`Double`	`getOnlyXLeftInStock()` Product stock only x left count
`String`	`getOptionsContainer()` If the product has multiple options, determines where they appear on the product page.
`ProductPrices`	`getPrice()` Deprecated. Use price_range for product price information.
`PriceRange`	`getPriceRange()` A PriceRange object, indicating the range of prices for the product
`List<TierPrice>`	`getPriceTiers()` An array of TierPrice objects.
`List<ProductLinksInterface>`	`getProductLinks()` An array of ProductLinks objects.
`Double`	`getRatingSummary()` The average of all the ratings given to the product.
`List<ProductInterface>`	`getRelatedProducts()` Related Products
`Integer`	`getReviewCount()` The total count of all the reviews given to the product.
`ProductReviews`	`getReviews()` The list of products reviews.
`ComplexTextValue`	`getShortDescription()` A short description of the product.
`String`	`getSku()` A number or code assigned to a product to identify the product, options, price, and manufacturer.
`ProductImage`	`getSmallImage()` The relative path to the small image, which is used on catalog pages.
`String`	`getSpecialFromDate()` Deprecated. The field should not be used on the storefront.
`Double`	`getSpecialPrice()` The discounted price of the product.
`String`	`getSpecialToDate()` The end date that a product has a special price.
`Boolean`	`getStaged()`
`ProductStockStatus`	`getStockStatus()` Stock status of the product
`String`	`getSwatchImage()` The file name of a swatch image
`ProductImage`	`getThumbnail()` The relative path to the product's thumbnail image.
`Double`	`getTierPrice()` Deprecated. Use price_tiers for product tier price information.
`List<ProductTierPrices>`	`getTierPrices()` Deprecated. Use price_tiers for product tier price information.
`String`	`getTypeId()` Deprecated. Use __typename instead.
`ID`	`getUid()` The unique ID for a `ProductInterface` object.
`String`	`getUpdatedAt()` Deprecated. The field should not be used on the storefront.
`List<ProductInterface>`	`getUpsellProducts()` Upsell Products
`String`	`getUrlKey()` The part of the URL that identifies the product
`String`	`getUrlPath()` Deprecated. Use product's `canonical_url` or url rewrites instead
`List<UrlRewrite>`	`getUrlRewrites()` URL rewrites list
`String`	`getUrlSuffix()` The part of the product URL that is appended after the url key
`List<Website>`	`getWebsites()` Deprecated. The field should not be used on the storefront.

Methods inherited from interface com.shopify.graphql.support.CustomFieldInterface
get, getAsArray, getAsBoolean, getAsDouble, getAsInteger, getAsString

- Method Detail
  - getGraphQlTypeName
```
String getGraphQlTypeName()
```
  - getAttributeSetId
```
@Deprecated
Integer getAttributeSetId()
```
    Deprecated. The field should not be used on the storefront.
    
    The attribute set assigned to the product.
  - getCanonicalUrl
```
String getCanonicalUrl()
```
    Relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled
  - getCategories
```
List<CategoryInterface> getCategories()
```
    The categories assigned to a product.
  - getColor
```
Integer getColor()
```
  - getCountryOfManufacture
```
String getCountryOfManufacture()
```
    The product's country of origin.
  - getCreatedAt
```
@Deprecated
String getCreatedAt()
```
    Deprecated. The field should not be used on the storefront.
    
    Timestamp indicating when the product was created.
  - getCrosssellProducts
```
List<ProductInterface> getCrosssellProducts()
```
    Crosssell Products
  - getDescription
```
ComplexTextValue getDescription()
```
    Detailed information about the product. The value can include simple HTML tags.
  - getGiftMessageAvailable
```
String getGiftMessageAvailable()
```
    Indicates whether a gift message is available.
  - getId
```
@Deprecated
Integer getId()
```
    Deprecated. Use the `uid` field instead.
    
    The ID number assigned to the product.
  - getImage
```
ProductImage getImage()
```
    The relative path to the main image on the product page.
  - getIsReturnable
```
String getIsReturnable()
```
    Indicates whether the product can be returned
  - getManufacturer
```
Integer getManufacturer()
```
    A number representing the product's manufacturer.
  - getMediaGallery
```
List<MediaGalleryInterface> getMediaGallery()
```
    An array of Media Gallery objects.
  - getMediaGalleryEntries
```
@Deprecated
List<MediaGalleryEntry> getMediaGalleryEntries()
```
    Deprecated. Use product's `media_gallery` instead
    
    An array of MediaGalleryEntry objects.
  - getMetaDescription
```
String getMetaDescription()
```
    A brief overview of the product for search results listings, maximum 255 characters.
  - getMetaKeyword
```
String getMetaKeyword()
```
    A comma-separated list of keywords that are visible only to search engines.
  - getMetaTitle
```
String getMetaTitle()
```
    A string that is displayed in the title bar and tab of the browser and in search results lists.
  - getName
```
String getName()
```
    The product name. Customers use this name to identify the product.
  - getNewFromDate
```
@Deprecated
String getNewFromDate()
```
    Deprecated. The field should not be used on the storefront.
    
    The beginning date for new product listings, and determines if the product is featured as a new product.
  - getNewToDate
```
@Deprecated
String getNewToDate()
```
    Deprecated. The field should not be used on the storefront.
    
    The end date for new product listings.
  - getOnlyXLeftInStock
```
Double getOnlyXLeftInStock()
```
    Product stock only x left count
  - getOptionsContainer
```
String getOptionsContainer()
```
    If the product has multiple options, determines where they appear on the product page.
  - getPrice
```
@Deprecated
ProductPrices getPrice()
```
    Deprecated. Use price_range for product price information.
    
    A ProductPrices object, indicating the price of an item.
  - getPriceRange
```
PriceRange getPriceRange()
```
    A PriceRange object, indicating the range of prices for the product
  - getPriceTiers
```
List<TierPrice> getPriceTiers()
```
    An array of TierPrice objects.
  - getProductLinks
```
List<ProductLinksInterface> getProductLinks()
```
    An array of ProductLinks objects.
  - getRatingSummary
```
Double getRatingSummary()
```
    The average of all the ratings given to the product.
  - getRelatedProducts
```
List<ProductInterface> getRelatedProducts()
```
    Related Products
  - getReviewCount
```
Integer getReviewCount()
```
    The total count of all the reviews given to the product.
  - getReviews
```
ProductReviews getReviews()
```
    The list of products reviews.
  - getShortDescription
```
ComplexTextValue getShortDescription()
```
    A short description of the product. Its use depends on the theme.
  - getSku
```
String getSku()
```
    A number or code assigned to a product to identify the product, options, price, and manufacturer.
  - getSmallImage
```
ProductImage getSmallImage()
```
    The relative path to the small image, which is used on catalog pages.
  - getSpecialFromDate
```
@Deprecated
String getSpecialFromDate()
```
    Deprecated. The field should not be used on the storefront.
    
    The beginning date that a product has a special price.
  - getSpecialPrice
```
Double getSpecialPrice()
```
    The discounted price of the product.
  - getSpecialToDate
```
String getSpecialToDate()
```
    The end date that a product has a special price.
  - getStaged
```
Boolean getStaged()
```
  - getStockStatus
```
ProductStockStatus getStockStatus()
```
    Stock status of the product
  - getSwatchImage
```
String getSwatchImage()
```
    The file name of a swatch image
  - getThumbnail
```
ProductImage getThumbnail()
```
    The relative path to the product's thumbnail image.
  - getTierPrice
```
@Deprecated
Double getTierPrice()
```
    Deprecated. Use price_tiers for product tier price information.
    
    The price when tier pricing is in effect and the items purchased threshold has been reached.
  - getTierPrices
```
@Deprecated
List<ProductTierPrices> getTierPrices()
```
    Deprecated. Use price_tiers for product tier price information.
    
    An array of ProductTierPrices objects.
  - getTypeId
```
@Deprecated
String getTypeId()
```
    Deprecated. Use __typename instead.
    
    One of simple, virtual, bundle, downloadable, grouped, or configurable.
  - getUid
```
ID getUid()
```
    The unique ID for a `ProductInterface` object.
  - getUpdatedAt
```
@Deprecated
String getUpdatedAt()
```
    Deprecated. The field should not be used on the storefront.
    
    Timestamp indicating when the product was updated.
  - getUpsellProducts
```
List<ProductInterface> getUpsellProducts()
```
    Upsell Products
  - getUrlKey
```
String getUrlKey()
```
    The part of the URL that identifies the product
  - getUrlPath
```
@Deprecated
String getUrlPath()
```
    Deprecated. Use product's `canonical_url` or url rewrites instead
  - getUrlRewrites
```
List<UrlRewrite> getUrlRewrites()
```
    URL rewrites list
  - getUrlSuffix
```
String getUrlSuffix()
```
    The part of the product URL that is appended after the url key
  - getWebsites
```
@Deprecated
List<Website> getWebsites()
```
    Deprecated. The field should not be used on the storefront.
    
    An array of websites in which the product is available.

Interface ProductInterface

Method Summary

Methods inherited from interface com.shopify.graphql.support.CustomFieldInterface

Method Detail

getGraphQlTypeName

getAttributeSetId

getCanonicalUrl

getCategories

getColor

getCountryOfManufacture

getCreatedAt

getCrosssellProducts

getDescription

getGiftMessageAvailable

getId

getImage

getIsReturnable

getManufacturer

getMediaGallery

getMediaGalleryEntries

getMetaDescription

getMetaKeyword

getMetaTitle

getName

getNewFromDate

getNewToDate

getOnlyXLeftInStock

getOptionsContainer

getPrice

getPriceRange

getPriceTiers

getProductLinks

getRatingSummary

getRelatedProducts

getReviewCount

getReviews

getShortDescription

getSku

getSmallImage

getSpecialFromDate

getSpecialPrice

getSpecialToDate

getStaged

getStockStatus

getSwatchImage

getThumbnail

getTierPrice

getTierPrices

getTypeId

getUid

getUpdatedAt

getUpsellProducts

getUrlKey

getUrlPath

getUrlRewrites

getUrlSuffix

getWebsites