Products

Below you will find documentation for:

the variables of the product.html page for the single product
the variables of the new-releases.html page where new products are listed
the variables of the search.html page for product search
the variables of the share.html page for sharing a product on social
the products variable for product lists

In addition to these, the pages product.html and share.html can also use the common variables for all pages.

product.html

Page with the details of a product.

Instruction	Variable	Description
for	accessories	Accessory products
show	addToCart	Button to add the product to the cart
show	addToWishList	Button to add the product to the wish list
for	allBreadcrumbs	All breadcrumbs, one for each main department of the product
for	attributes	List of product attributes
for	breadcrumbs	List of departments from the main one to the deepest one where the product is located
show	code	Stock code
show	department	Department
show	discount	Discount compared to list price
show	discountTax	Discount, VAT included, compared to list price
show	ean	EAN13 code of the primary reference
for	files	Downloadable attachments
show	id	Product identifier
show	image	Large image
if	isAvailable	Indicates whether it is available and can be ordered
show	isbn	ISBN13 code of the primary reference
if	isDiscounted	Indicates whether the price is discounted
if	isForSale	Indicates whether it is for sale
if	isInStock	Indicates whether the quantity in stock is greater than zero. If the product has multiple references then it always has a false value
if	isNewRelease	Indicates whether it is a new release
if	isPreOrder	Indicates whether it is available for pre-order
for	items	Product references
show	listPrice	List price
show	listPriceTax	List price including VAT
show	longDescription	Long description
show	metaOGImage	Meta tag `<meta property="og:image">` that tells sites like Facebook which image to use for sharing. To be inserted between `<head>` and `</head>`
show	minQuoteMessage	Message that informs the customer that they can request a quote for the product with a minimum quantity
show	moreDescription	Additional description
show	name	Product name
show	percentDiscount	Discount percentage
show	percentTax	Tax percentage
show	preOrderMessage	Message that informs the customer the product is available for pre-order
show	price	Sale price
show	priceTax	Sale price including VAT
show	producer	Producer
show	producerLogo	Producer logo
show	promotionMessage	Message that informs the customer that the product is on promotion
show	quantity	Field to indicate the quantity to add to the cart
show	reviewRating	Product rating. Generally displayed with five stars
for	reviews	Product reviews
show	shippingDate	Estimated shipping date. Usable only if the product has no variants and has a single reference. If the product is in stock then the date is the following day, otherwise as many days are added as the supplier reorder days
show	shortDescription	Short description
if	showPrices	Indicates whether prices can be shown to the customer
for	similar	Similar products
show	socialSharing	Social sharing
show	statusMessage	Informs the customer about possible errors when adding the product to the cart
show	thumbnails	Product image thumbnails
show	upc	UPC code of the primary reference
for	variants	Variants

for accessories

Instruction	Variable	Description
show	columns	Number of columns to display products
for	products	Accessory products

for allBreadcrumbs

Instruction	Variable	Description
for	breadcrumbs	List of departments from the main one to the deepest one where the product is located

for attributes

Instruction	Variable	Description
show	id	Identifier
show	name	Name
for	values	List of values

for files

Instruction	Variable	Description
show	description	Description
show	size	Size in KB

for items

Instruction	Variable	Description
show	addToCart	Button to add the reference to the cart. Available if stock is greater than zero or the reference is still orderable.
show	discount	Discount compared to list price
show	discountTax	Discount, VAT included, compared to list price
show	ean	EAN13 code
show	image	Image
show	isbn	ISBN13 code
if	isForSale	Indicates whether it is for sale
show	listPrice	List price
show	listPriceTax	List price including VAT
show	maximumOrderQuantity	Maximum orderable quantity
show	minimumOrderQuantity	Minimum orderable quantity
for	options	Options
show	percentDiscount	Percentage discount compared to list price
show	percentTax	VAT percentage
show	price	Price
for	prices	Prices by quantity tiers
show	priceTax	Price including VAT
show	quantity	Quantity to add to the cart. Available if stock is greater than zero or the reference is still orderable
show	shippingDate	Estimated shipping date. If the reference is in stock then it is the day after the current date, if it is not available but still orderable then the days needed to reorder are added, otherwise the date is not present
if	showPrices	Indicates whether prices can be shown to the customer
show	sku	Stock code
show	stock	Available quantity
show	upc	UPC code
show	weight	Weight

for prices

The prices variable is used to display the quantity price table in B2B editions. Each value of prices is a price tier that can be shown as a row of the table.

Instruction	Variable	Description
show	discount	Fixed discount compared to list price
show	from	Quantity from which the price applies
show	listPrice	List price
show	listPriceTax	List price including VAT
show	percentDiscount	Percentage discount compared to list price
show	price	Price
show	priceTax	Price including VAT
show	to	Quantity up to which the price applies. Not present in the last tier

for reviews

Instruction	Variable	Description
show	author	Author name
show	content	Content
show	date	Date it was written
show	rating	Rating. Generally displayed with five stars
show	summary	Summary

for similar

Instruction	Variable	Description
show	columns	Number of columns to display products
for	products	Similar products

for values

Instruction	Variable	Description
show	id	Identifier
show	name	Name
show	icon	Icon
show	description	Description

for variants

Instruction	Variable	Description
show	name	Name
show	options	Options. Menu to select the option

for options

Instruction	Variable	Description
show	name	Name
show	variant	Variant

search.html

Allows advanced product search and shows the results.

Instruction	Variable	Description
for	breadcrumbs	List of departments from the main one to the deepest one where the product is located
show	category	Category to search in
show	columns	Number of columns to display products
show	content	Page content
show	count	Number of products found
show	department	Department to search in
if	hasBeenExecuted	Indicates whether the search has been executed
show	keywords	Keywords to search for
show	image	Page image
show	producer	Producer to search in
show	paging	Pagination, allows moving to the next products
for	products	Products returned by the search
show	search	Button to perform the search
show	sortBy	Menu to choose product sorting
show	title	Page title

new-releases.html

Lists all new products.

Instruction	Variable	Description
show	columns	Number of columns to display products
show	content	Page content
show	count	Number of new products
show	image	Page image
show	paging	Pagination, allows moving to the next products
for	products	New products
show	sortBy	Menu to choose product sorting
show	title	Page title

share.html

Allows sharing a product via email.

Instruction	Variable	Description
show	content	Page content
show	message	Message to write in the email. It can be written only by customers who have logged in
show	image	Page image
show	recipients	Email recipients
show	send	Button to send the email
show	senderEmail	Sender email address
show	senderName	Sender name
show	shareImage	Image of the product or promotion
show	shareName	Name of the product or promotion
show	statusMessage	Message that informs about the result of sending the email or any errors
show	title	Page title

products

The products variable is used in the pages index.html, department.html, producer.html, search.html, new-releases.html, wish-list.html and product.html to display products.

It is also used on all pages in the context of for topSellers to display the best-selling products.

<!-- .for products --> ... <!-- .end for -->

The products displayed depend on the page in which the variable is used and possibly also on the for instruction in which it is located. For example, in department.html it displays the products of the department, in wish-list.html it displays the products in the customer's wish list.

On the product.html page, if used in the context of for accessories it displays the product accessories, while if used in the context of for similar it displays similar products.

Instruction	Variable	Description
show	addToCart	Button to add the product to the cart
show	addToWishList	Button to add the product to the wish list
show	code	Code
show	department	Main product department
show	discount	Discount compared to list price
show	id	Identifier
if	isNewRelease	Indicates whether it is a new release
if	isForSale	Indicates whether it is for sale
if	isPreOrder	Indicates whether it is available for pre-order
show	largeImage	Large image. It can be displayed in small or medium size if indicated in the admin
show	listPrice	List price
show	mediumImage	Medium image. It can be displayed in small or large size if indicated in the admin
show	minQuoteMessage	Message that informs the customer that they can request a quote for the product with a minimum quantity
show	name	Name
show	percentDiscount	Percentage discount compared to list price
show	percentTax	VAT percentage
show	position	Product position in the list starting from one. Used especially in best-selling products
show	preOrderMessage	Message that informs that the product is available for pre-order
show	price	Sale price
show	producer	Producer
show	producerLogo	Logo
show	remove	Button to remove it from the wish list. It is available only on the `wish-list.html` page
show	reviewRating	Product rating. Generally displayed with five stars.
show	shortDescription	Short description
show	showPrices	Indicates whether prices are visible to the customer
show	smallImage	Small image. It can be displayed in medium or large size if indicated in the admin

How useful was this page?

Thank you for helping us improve this page