Skip to main content

Product

The product object contains all relevant data for a single product variant, including variant characteristics, pricing, availability, images, and other metadata.

Properties​

VariableDescriptionComment
idID of the product variant
skuSKU (Stock Keeping Unit)
eanEAN barcode
upcUPC barcode
mpnManufacturer part number
serialProduct serial number
product_idID of the parent product
stockStock quantity
conditionCondition of the product (new, used, etc.)
updated_atTimestamp of last update
created_atTimestamp of creation
vendor_packageVendor packaging information
end_dateEnd date for availability or promotionNullable
orderOrder index or sequence
rankProduct rank for sorting
status_idStatus identifier
avg_monthly_ordersAverage monthly orders
last_month_orders_trendTrend of orders in the last month
abc_categoryABC classification for inventory management
activated_atActivation dateNullable
lengthProduct length
widthProduct width
heightProduct height
videosList of product videos
base_currency_codeBase currency code
preorderIndicates if product is available for pre-orderBoolean
variant_chatacteristicsArray of variant characteristics (colors, sizes, etc.)
schemasStructured data
release_dateProduct release dateNullable
sales_channelSales channels where the product is available
nameProduct name
titleProduct title
short_descriptonShort description
descriptionFull description
slugURL-friendly identifier
urlFull URL to product page
category_idCategory ID
imagesArray of product images
discountDiscount percentage or valueNullable
availabilityText representation of product availability
availability_buttonStatus for availability button (e.g., in stock, out of stock)
measurementsMeasurements (dimensions, weight, etc.)
price.amountPrice amount for current webshop
price.currencyPrice currency
original_price.amountOriginal price before discount
original_price.currencyCurrency of original price
discount_price.amountDiscounted price (if applicable)Nullable
discount_price.currencyCurrency of discounted priceNullable

Product card​

The products of a list page (products), of a featured-products block (section.products) and similar blocks are cards: a product variant with the values a card needs, in the current language and currency. The same object comes for a bundle (is_bundle).

VariableDescriptionComment
id, variant_idID of the product variant
product_idID of the parent productVariants only
sku, ean, upc, mpnCodes of the variantVariants only
serialSerial number of the product
titleThe product name in the current language
short_descriptonShort description in the current language
urlFull URL of the product page on the current sale channel: /product/{id}-{slug}/{variant}
priceThe price the customer pays (amount, currency): the discount price when there is one
original_priceThe price before the discount (amount, currency)
discount_priceThe discount price (amount, currency)null without a discount
stockStock in the sale channel's warehouses, with the incoming stock
preorderThe variant can be pre-orderedBoolean
imageThe main image (the first one when none is main). Use it with image_url and image_srcset.
imagesAll the images of the variant
is_variant, is_bundletrue for a product variant / for a bundleBoolean
main_characteristicThe ID of the variant's value of the main characteristic (the colour on a fashion shop)Nullable
main_characteristic_familyThe values of the main characteristic the product has in stock, one row per value: c_id, variant_id (a variant with that value), name, hex (a colour swatch), has_imageArray
colorsThe values of the main characteristic of this card, when the block asks for them: id, val, hex, has_imageArray
release_dataRelease date of the productNullable
created_at, updated_at, activated_atTimestamps of the variant

The main characteristic is the variant-forming characteristic marked main_characteristics in the Prodyflow settings: the template does not assume which one it is.

Product page​

VariableDescription
productThe product object
titlePage title, usually including the product name and selected variant
descriptionMeta description of the product page
langCurrent language code
shopsList of available shops or sales channels
top_categoriesList of top-level categories for navigation
layoutLayout data for rendering the page
similar_productsList of related products for recommendation blocks
delivery_dateEstimated delivery date message

Schema​

element in schema object

keyDescription
brandBrand of the product
authorAuthor of the product (for books, media)
colorColor of the product
manufacturerManufacturer of the product
materialMaterial used in the product
modelModel name or number
release_dateRelease date of the product
sizeSize of the product
patternPattern or design
is_adultIndicates if the product is adult-only
bundleBundle or set
energy_efficiency_classEnergy efficiency classification
age_groupTarget age group
genderIntended gender
size_systemSize system used (EU, US, UK, etc.)
weightWeight of the product
box_sizeDimensions of the product box
line_nameProduct line or series name