Frontend | Backend | Api

Products\Models\Api\BaseProduct

Product

Property Description Returns
variant Returns if product is variant bool
text Get the short description in the default language for this product string
defaultPricing Get the default pricing ProductPricing
finalPrice Calculates the final price for the product in current currency for the current user based on the provided pricing. If *base price* of the product is `0.00`, such product could be added to the cart. If other prices (e.g. *special price*) are `0`, they are ignored and *base price* is returned (that could be `0.00`). string
name Fetches the name in the default description for this container string
slug Fetches the slug for the default description for this container string
fullSlug Fetches the full slug for the default description for this container string
fullPath Fetches the full path for the default description for this container string
originalPath Fetches the original path for the container without any custom urls applied string
defaultDescription Fetches the description in the default language for this container. If no description in the default language, fetches the first one. If still no description exists, creates a new description with the default language. Model
id int
code The code that uniquely identifies this product string
externalId string
purchasable bool
availableFrom DateTime
availableTill DateTime
created Date the record was created. DateTime
modified Last modification date for the record. DateTime
published DateTime
published Determines if the record is published. bool
image Image
site Site
descriptions Collection (ProductDescription)
pricings Collection (ProductPricing)
width string
height string
depth string
weight string
availableQuantity int
inventoryTemplate string
stocks Collection (Stock)
interests Collection (ProductInterest)