{module_productfeaturelist}

Description

Displays using the Individual Product - Small layout all the products tagged with a specified tag.

Syntax

{module_productfeaturelist render="collection" tag="featured" rowCount="4" sortType="Weight" collection="my_custom_collection_name" template="/folder/template.tpl"}

Note: When using named parameters always wrap the individual parameters in double quotes. Also, do note that modules using named parameters do not work for campaigns just yet.

Parameters

  • render - for this module the value of this parameter can only be collection (if no value is specified the default will be collection). For more information on how to use this parameter take a look at the render parameter's article for more details on how to use it
  • tag being the product tag
  • rowCount - will limit the number of items displayed
  • sortType can be alphabetical, price, date, expirydate or weight
  • targetFrame - possible values are _blank, _self and _top. This parameter is used to specify the frame you want the item to open in.
  • useBackupLayout can be true or false. The value of this parameter is ignored if the template parameter is also present.
  • collection - use this if you need to access the module's Liquid output tags
  • template - render the module using a custom template. You can leave the value of the template parameter blank to suppress the original output and use Liquid output tags instead

This module can be rendered:

The {module_productfeaturelist} module is always rendered using either the Individual Product - Small layout or the backup one. The site visitor is redirected to the product detail view (rendered using the Individual Product - Large layout) only after clicking one of the links outputted by one of these tags: {tag_button,Your Text}, {tag_name} or {tag_itemurl_withhost}.

  • the individual product layout - on this layout you can use either the legacy tags or Liquid output tags. Here is a list of all the tags you can use: Individual Product - Small reference page
  • your own custom layout - take a look at the custom templates article for more details
  • Liquid collections - here are the Liquid output tags you can use:
Liquid tag Legacy tag Description
{{title}} The product's title
{tag_addtocart}Ability to add products to the shopping cart (vertical layout)
{tag_addtocartinputfield}Input field to enter product quantity
{tag_addtofavorites,add_Image, remove_Image}Add product to favorites list. Optionally customize to display your own custom image for adding and removing.
For additional information on how to render the output of this tag using Liquid take a look at the Enable other Liquid tags article.
{{attributes}} {tag_attributes, horizontal, hideDisabledVariations, autoSelectFirstVariation}

Renders attribute dropdowns for a given product:

  • horizontal - display attributes horizontally
  • hideDisabledVariations - true or false
  • autoSelectFirstVariation - true or false

The Liquid tag renders an object, use json filter to see it's properties like so: null

{tag_button,Your Text}Replace Your Text with your own text; for example, Click for more information
{tag_buynow}Add to cart and redirects to check out
{{countryCode}} {tag_countrycode}Display the country code; for example, AU
{{countryCurrencyFormat}} {tag_countrycurrencyformat}Display the country currency code; for example, AUD
{{currencyFormat}} {tag_currencyformat}Display the currency format; for example, $
{{custom1}} {tag_custom1}Custom field #1. Use to display any information about a product
{{custom2}} {tag_custom2}Custom field #2. Use to display any information about a product
{{custom3}} {tag_custom3}Custom field #3. Use to display any information about a product
{{custom4}} {tag_custom4}Custom field #4. Use to display any information about a product
{{description}} {tag_description}Description of the product (Editor content)
{{discountPrice}} {tag_discountprice}The price if a discount applies to the current customer otherwise the normal sale price.
{{expiryDate}} {tag_expirydate}Expiration date of product
{tag_grouping}Pop-up menu of product attributes used to select a product to add to cart
{{groupingList}} {tag_groupinglist}List of product attributes used to switch between products
{{inStock}} {tag_instock, syncWithAttributes, noSelectionMessage, disabledSelectionMessage} Number of units in stock.

Parameters:

  • syncWithAttributes – true or false
  • noSelectionMessage – specify the message displayed when site customer has not selected a variation
  • disabledSelectionMessage – specify the message displayed when site customer has selected a variation that is disabled
{{url}} {tag_itemurl_nolink}URL to the item referred, without host
{{urlWithHost}} {tag_itemurl_withhost}URL to the item referred, with host
{tag_largeimage}Large image for product
{{largeImageUrl}} {tag_largeimage_path}Outputs the file path of the image; for example /images/imagename.jpg
{{maxUnits}} {tag_maxunits}Maximum units
{{minUnits}} {tag_minunits}Minimum units
{tag_name_nolink}Name of product (does not link to product details)
{{name}} {tag_name}Name of product
{{onOrder}} {tag_onorder, syncWithAttributes, noSelectionMessage, disabledSelectionMessage} Number of units on order.

Parameters:

  • syncWithAttributes – true or false
  • noSelectionMessage – specify the message displayed when site customer has not selected a variation
  • disabledSelectionMessage – specify the message displayed when site customer has selected a variation that is disabled
{{isOnSale}} {tag_onsale}Renders 1 if product on sale, otherwise 0. If page elements need to be altered for products on sale, then embed tag in relevant javascript.
{{productCode}} {tag_productcode, syncWithAttributes, noSelectionMessage, disabledSelectionMessage} Product code. With variations enabled, tg product will render the variation code instead of the product codes in all layouts where this is used.

Parameters:

  • syncWithAttributes – true or false
  • noSelectionMessage – specify the message displayed when site customer has not selected a variation
  • disabledSelectionMessage – specify the message displayed when site customer has selected a variation that is disabled
{{releaseDate}} {tag_releasedate}Release date of item
{{reorder}} {tag_reorder}Number of units to reorder threshold
{{retailPrice}} {tag_retailprice}Retail price of the product
{{salePrice}} {tag_saleprice}Sale price of the product (the amount that customers are charged)
{{wholesalerPrice}} {tag_wholesalerprice} Wholesaler price of the product (the amount "wholesale" type customers are charged)
{{smallImage}} {tag_smallimage_nolink}Small image for product (does not link to product details)
{tag_smallimage}Small image for product
{{smallImageUrl}} {tag_smallimage_path}Outputs the file path of the image; for example /images/imagename.jpg
{{tags}} {tag_tags}Product tags (you can use field for anything)
{{tax}} {tag_tax}Tax amount for the product
{{taxCode}} {tag_taxcode}Tax code name used for item
{{taxRate}} {tag_taxrate}Tax rate used for item (%)
{{totalDiscountPrice}} {tag_totaldiscountprice}Total discounted price of the product: Discount Price + Tax.
{{totalPrice}} {tag_totalprice}Total price of the productT: Sale Price + Tax
{{totalRetailPrice}} {tag_totalretailprice}Total retail price of the product: Retail Price + Tax
{{unitType}} {tag_unittype}Product unit type: Single, by the dozen
{tag_volumeprices}Displays volume pricing for product
{{id}} {tag_productid}Displays product system id
{{catalogId}} {tag_catalogueid}Displays catalog system id the product is currently displayed in
{{inventoryByAttributes}} Renders a JSON object that containsthe following parameters:
  • id
  • sku
  • inStock
  • onOrder
  • enabled
  • attributeString
  • attributes

Examples

  • {module_productfeaturelist tag="special offer"} - lists all the products that are tagged with the "special offer" tag
  • {module_productfeaturelist tag="special offer" sortType="price" targetFrame="_blank" useBackupLayout="true"} - lists the products that are tagged with the "special offer" tag using the backup template. The products are sorted by price (cheapest first) and when clicking the product's name the detail view opens in a new window
  • {module_productfeaturelist tag="special offer" rowCount="3" sortType="price" targetFrame="_blank" useBackupLayout="true" template="/layouts/custom/productfeaturelist.tpl"} - lists 3 products that are tagged with the "special offer" tag using a custom template (the "true" parameter that states the backup template should be used is ignored). The products are sorted by price (cheapest first) and when clicking the product's name the detail view opens in a new window
  • {module_productfeaturelist tag="special offer" collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.

Syntax

{module_productfeaturelist,tag,rowLength,sortType,targetFrame,useBackupTemplate}

Parameters

  • tag being the product tag
  • rowLength e.g. 3
  • sortType can be alphabetical, price, date, expirydate or weight
  • targetFrame - possible values are _blank, _self and _top. This parameter is used to specify the frame you want the item to open in.
  • useBackupTemplate can be true or false

Layouts

The {module_productfeaturelist} module is always rendered using either the Individual Product - Small layout or the backup one. The site visitor is redirected to the product detail view (rendered using the Individual Product - Large layout) only after clicking one of the links outputted by one of these tags: {tag_button,Your Text}, {tag_name} or {tag_itemurl_withhost}.

Examples

  • {module_productfeaturelist,special offer} - lists all the products that are tagged with the "special offer" tag
  • {module_productfeaturelist,special offer,,price,_blank,true} - lists the products that are tagged with the "special offer" tag using the backup template. The products are sorted by price (cheapest first) and when clicking the product's name the detail view opens in a new window
  • {module_productfeaturelist,special offer,3,price,_blank,true template="/layouts/custom/productfeaturelist.tpl"} - lists 3 products that are tagged with the "special offer" tag using a custom template (the "true" parameter that states the backup template should be used is ignored). The products are sorted by price (cheapest first) and when clicking the product's name the detail view opens in a new window