{module_cataloguelistdump}

Description

Displays the List of all Catalogues as names that are links to those catalogues.

Syntax

{module_cataloguelistdump 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 - Use -1 to display parent catalogs, use -2 to display all catalogs including sub-catalogs
  • rowCount - will limit the number of items per row when items are displayed as a list. Default is 1 item per row
  • targetFrame - e.g. _blank. Specify the frame you want the item to open in
  • sortType - will sort the web apps 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
  • Liquid collections - the output is a Liquid collection containing the catalogs:

 "dump": {
    "moduleName": "cataloguelistdump",
    "moduleDescriptor": {
      "templatePath": "",
      "parameters": "collection=\"dump\"",
      "apiEndpoint": "/api/v3/cataloguelistdump",
      "objectType": "75",
      "objectId": "-1",
      "adminUrl": ""
    },
    "items": [
      {
        "name": "Classic Boutique",
        "url": "/classic-boutique"
      },
      {
        "name": "Designer Brands",
        "url": "/designer-brands"
      },
      {
        "name": "Spicy Perfumes",
        "url": "/spicy-perfumes"
      },
      {
        "name": "Woody Perfumes",
        "url": "/woody-parfumes"
      }
    ]
  }

Examples

  • {module_cataloguelistdump catalogId="-1" rowCount="1" targetFrame="_blank" sortType="Alphabetical"} - this module will display the catalogue list in the new window, alphabetically and all in one column
  • {module_cataloguelistdump catalogId="-1" 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_cataloguelistdump,catalogID,rowLength,targetFrame,sortBy}

Parameters

  • catalogID - Use -1 to display parent catalogs, use -2 to display all catalogs including sub-catalogs
  • rowLength - will limit the number of items per row when items are displayed as a list. Default is 1 item per row
  • targetFrame - e.g. _blank. Specify the frame you want the item to open in
  • sortBy - will sort the web apps in specified order
    • Alphabetical - sorts items alphabetically
    • Weight - sorts items by weight

Examples

  • {module_cataloguelistdump,-1,1,_blank,Alphabetical} - this module will display the catalogue list in the new window, alphabetically and all in one column