Product
The product object contains all relevant data for a single product variant, including variant characteristics, pricing, availability, images, and other metadata.
Properties
| Variable | Description | Comment |
|---|---|---|
id | ID of the product variant | |
sku | SKU (Stock Keeping Unit) | |
ean | EAN barcode | |
upc | UPC barcode | |
mpn | Manufacturer part number | |
serial | Product serial number | |
product_id | ID of the parent product | |
stock | Stock quantity | |
condition | Condition of the product (new, used, etc.) | |
updated_at | Timestamp of last update | |
created_at | Timestamp of creation | |
vendor_package | Vendor packaging information | |
end_date | End date for availability or promotion | Nullable |
order | Order index or sequence | |
rank | Product rank for sorting | |
status_id | Status identifier | |
avg_monthly_orders | Average monthly orders | |
last_month_orders_trend | Trend of orders in the last month | |
abc_category | ABC classification for inventory management | |
activated_at | Activation date | Nullable |
length | Product length | |
width | Product width | |
height | Product height | |
videos | List of product videos | |
base_currency_code | Base currency code | |
preorder | Indicates if product is available for pre-order | Boolean |
variant_chatacteristics | Array of variant characteristics (colors, sizes, etc.) | |
schemas | Structured data | |
release_date | Product release date | Nullable |
sales_channel | Sales channels where the product is available | |
name | Product name | |
title | Product title | |
short_descripton | Short description | |
description | Full description | |
slug | URL-friendly identifier | |
url | Full URL to product page | |
category_id | Category ID | |
images | Array of product images | |
discount | Discount percentage or value | Nullable |
availability | Text representation of product availability | |
availability_button | Status for availability button (e.g., in stock, out of stock) | |
measurements | Measurements (dimensions, weight, etc.) | |
price.amount | Price amount for current webshop | |
price.currency | Price currency | |
original_price.amount | Original price before discount | |
original_price.currency | Currency of original price | |
discount_price.amount | Discounted price (if applicable) | Nullable |
discount_price.currency | Currency of discounted price | Nullable |
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).
| Variable | Description | Comment |
|---|---|---|
id, variant_id | ID of the product variant | |
product_id | ID of the parent product | Variants only |
sku, ean, upc, mpn | Codes of the variant | Variants only |
serial | Serial number of the product | |
title | The product name in the current language | |
short_descripton | Short description in the current language | |
url | Full URL of the product page on the current sale channel: /product/{id}-{slug}/{variant} | |
price | The price the customer pays (amount, currency): the discount price when there is one | |
original_price | The price before the discount (amount, currency) | |
discount_price | The discount price (amount, currency) | null without a discount |
stock | Stock in the sale channel's warehouses, with the incoming stock | |
preorder | The variant can be pre-ordered | Boolean |
image | The main image (the first one when none is main). Use it with image_url and image_srcset. | |
images | All the images of the variant | |
is_variant, is_bundle | true for a product variant / for a bundle | Boolean |
main_characteristic | The ID of the variant's value of the main characteristic (the colour on a fashion shop) | Nullable |
main_characteristic_family | The 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_image | Array |
colors | The values of the main characteristic of this card, when the block asks for them: id, val, hex, has_image | Array |
release_data | Release date of the product | Nullable |
created_at, updated_at, activated_at | Timestamps 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
| Variable | Description |
|---|---|
product | The product object |
title | Page title, usually including the product name and selected variant |
description | Meta description of the product page |
lang | Current language code |
shops | List of available shops or sales channels |
top_categories | List of top-level categories for navigation |
layout | Layout data for rendering the page |
similar_products | List of related products for recommendation blocks |
delivery_date | Estimated delivery date message |
Schema
element in schema object
| key | Description |
|---|---|
| brand | Brand of the product |
| author | Author of the product (for books, media) |
| color | Color of the product |
| manufacturer | Manufacturer of the product |
| material | Material used in the product |
| model | Model name or number |
| release_date | Release date of the product |
| size | Size of the product |
| pattern | Pattern or design |
| is_adult | Indicates if the product is adult-only |
| bundle | Bundle or set |
| energy_efficiency_class | Energy efficiency classification |
| age_group | Target age group |
| gender | Intended gender |
| size_system | Size system used (EU, US, UK, etc.) |
| weight | Weight of the product |
| box_size | Dimensions of the product box |
| line_name | Product line or series name |