{module_productlistdump}

Description

Displays a list of products (in a given catalog or all the products on the site). This module does not use a layout, its output is an unordered list.

Syntax

{module_productlistdump catalogId="14886" rowCount="2" targetFrame="_blank" sortType="Weight" collection="my_custom_collection_name" template=""}

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

  • catalogId - the catalogID, the productlistdump will list the products inside that catalog. This can also be "-1" - this will list all the products in the site.
  • rowCount - will limit the number of items per row when items are displayed as a list. Default is 1 item per row
  • targetFrame - possible values are _blank, _self and _top. This parameter is used to specify the frame you want the item to open in.
  • sortType - will sort the item in specified order
    • Alphabetical - sorts items alphabetically
    • Weight - sorts items by weight
  • collection - use this if you need to access the module's Liquid output tags
  • template - this module does not support custom templates. You can use the template parameter however to supress the module's output

This module can be rendered using:

  • a generic unordered list:
    <ul class="catalogueitemdump">
    <li><a href="/catalog1/product1">This is my first product</a></li>
    <li><a href="/catalog1/product2">This is my secondproduct</a></li>
    </ul>
  • Liquid collections - the output is a Liquid collection containing the products:

"dump": {
    "moduleName": "productlistdump",
    "moduleDescriptor": {
      "templatePath": "",
      "parameters": "collection=\"dump\"",
      "apiEndpoint": "/api/v3/productlistdump",
      "objectType": "27",
      "objectId": "-1",
      "adminUrl": "/Admin/Products_Detail.aspx?ProductID=-1"
    },
    "items": [
      {
        "name": "Sample Product 1",
        "url": "/spicy-perfumes/sample-product-1"
      },
      {
        "name": "Sample Product 2",
        "url": "/designer-brands/sample-product-2"
      },
      {
        "name": "Sample Product 3",
        "url": "/designer-brands/sample-product-3"
      },
      {
        "name": "Sample Product 4",
        "url": "/woody-parfumes/sample-product-4"
      },
      {
        "name": "Sample Product 5",
        "url": "/classic-boutique/sample-product-5"
      },
      {
        "name": "Sample Product 6",
        "url": "/woody-parfumes/sample-product-6"
      },
      {
        "name": "Sample Product 7",
        "url": "/spicy-perfumes/sample-product-7"
      },
      {
        "name": "Sample Product 8",
        "url": "/classic-boutique/sample-product-8"
      }
    ]
  }

Examples

  • {module_productlistdump catalogId="63858" targetFrame="_blank" sortType="Alphabetical"} - displays all the products in the catalog with the ID 63858 ordered alphabetically. Clicking a product will open its detail view (rendered using the Individual Product - Large layout) in a new tab.
  • {module_productlistdump catalogId="-1" targetFrame="_self" sortType="weight"} - displays all the products regardless of the catalog they are in ordered by weight. Clicking a product will open its detail view (rendered using the Individual Product - Large layout) in the same tab.
  • {module_productlistdump catalogId="63858" 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_productlistdump,catID,rowLength,targetFrame,sortBy}

Parameters

  • catID - the catalogID, the productlistdump will list the products inside that catalog. This can also be "-1" - this will list all the products in the site.
  • rowLength - will limit the number of items per row when items are displayed as a list. Default is 1 item per row
  • targetFrame - possible values are _blank, _self and _top. This parameter is used to specify the frame you want the item to open in.
  • sortBy - will sort the item in specified order
    • Alphabetical - sorts items alphabetically
    • Weight - sorts items by weight

This module is not rendered using a layout.

The list of catalogs is ordered as an unordered list:

<ul class="catalogueitemdump">
<li><a href="/catalog1/product1">This is my first product</a></li>
<li><a href="/catalog1/product2">This is my secondproduct</a></li>
</ul>

Examples

  • {module_productlistdump,63858,,_blank,Alphabetical} - displays all the products in the catalog with the ID 63858 ordered alphabetically. Clicking a product will open its detail view (rendered using the Individual Product - Large layout) in a new tab.
  • {module_productlistdump,-1,,_self,weight} - displays all the products regardless of the catalog they are in ordered by weight. Clicking a product will open its detail view (rendered using the Individual Product - Large layout) in the same tab.