ProductInterface
Contains fields that are common to all types of products.
Declared or extended by: Catalog, CatalogCustomer, CatalogInventory, CatalogUrlRewrite, GiftMessage, Inventory, RelatedProduct, Review, Swatches
Fields
The ID number assigned to the product.
The unique ID for a `ProductInterface` object.
The product name. Customers use this name to identify the product.
A number or code assigned to a product to identify the product, options, price, and manufacturer.
Detailed information about the product. The value can include simple HTML tags.
A short description of the product. Its use depends on the theme.
The discounted price of the product.
The beginning date that a product has a special price.
The end date for a product with a special price.
The attribute set assigned to the product.
A string that is displayed in the title bar and tab of the browser and in search results lists.
A comma-separated list of keywords that are visible only to search engines.
A brief overview of the product for search results listings, maximum 255 characters.
The relative path to the main image on the product page.
The relative path to the small image, which is used on catalog pages.
The relative path to the product's thumbnail image.
The beginning date for new product listings, and determines if the product is featured as a new product.
The end date for new product listings.
The price when tier pricing is in effect and the items purchased threshold has been reached.
If the product has multiple options, determines where they appear on the product page.
Timestamp indicating when the product was created.
Timestamp indicating when the product was updated.
The product's country of origin.
One of simple, virtual, bundle, downloadable, grouped, or configurable.
An array of websites in which the product is available.
An array of `ProductLinks` objects.
An array of MediaGalleryEntry objects.
Indicates the price of an item.
The range of prices for the product
Indicates whether a gift message is available.
A number representing the product's manufacturer.
The categories assigned to a product.
The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
An array of media gallery objects.
Product custom attributes.
An array of ProductTierPrices objects.
An array of `TierPrice` objects.
Remaining stock if it is below the value assigned to the Only X Left Threshold option in the Admin.
The stock status of the product.
Amount of available stock
Minimum Qty Allowed in Shopping Cart
Maximum Qty Allowed in Shopping Cart
The part of the URL that identifies the product
The part of the product URL that is appended after the url key
URL rewrites list
An array of products to be displayed in a Related Products block.
Upsell Products
Crosssell Products
The average of all the ratings given to the product.
The total count of all the reviews given to the product.
The list of products reviews.
The file name of a swatch image.
Every Magento dev tool, in one hosted workspace.
Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.