Skip to main content
  1. Home
  2. Online store
  3. Old: CMS & Callisto online store
  4. CMS syntax

CMS syntax

The new Ceres online store

As of now, online store projects are based on the new online store plugin Ceres. The Ceres store uses the latest and future-proof plugin technology. Ceres can be customised easily and extended by additional plugins from the plentyMarketplace .

Online stores that have been created on the basis of the old CMS will be maintained during the transition period. However, no new features will be developed for the old CMS. We recommend to use the new Ceres online store for all future online store projects.

1. General information

The CMS syntax is a script language that is used in the web design, categories and email templates of plentymarkets. The CMS syntax was introduced in plentymarkets version 5.1. New language constructs and functions are added continuously.

Basic concepts

Compiler
Block
Comment

Types

Primitive types

Variables

Private variables
Template variables

Operators

Operators

Control structures

if / elseif / else
for

Functions

Template functions

2. Templates

You can find information on all templates for designing your online store and your email templates in this chapter of the manual.

Global

This section describes PHP functions that are used in the web design and email templates.

Open PHP functions

Web design

This section is divided into subsections. These sections describe all templates and functions available for designing your online store.

Open Web design

Email

List of template variables and functions available for creating your email templates.

Open email

3. Basics

3.1. Contents

Basics

Compiler
Block
Comment

Types

Primitive types

Variables

Private variables
Template variables

Operators

Operators

Control structures

if / elseif / else
for

Functions

Template functions

3.2. Compiler

3.2.1. General information about the compiler

The CMS syntax is processed by a compiler that translates the programming code into PHP programming code. The behavior of supported expressions thus corresponds to the relevant PHP expression. Additional default PHP functions will be incorporated into the CMS syntax in the future.

3.2.2. Publishing templates

When a template e.g. is saved in the Web design section of plentymarkets, the content is saved in the database first. The template is published after this step. By publishing, we mean that the programming code is translated to PHP programming code by the compiler and that the result is saved to the web space as a PHP class. These PHP classes are used to render content, e.g. in your online store.

3.2.3. Syntax errors

The compiler identifies syntax errors and returns an error message in plentymarkets. If an error is found, the template will not be published. However, the programming code will be saved in the database. This means that you need to correct the error to fully publish a web design or an email template.

3.3. Block

3.3.1. Video tutorial

3.3.2. General information about blocks

A block contains programming code and can also contain comments. For the compiler to process programming code, this code needs to be contained in a statement block. Blocks are inserted directly into existing templates. A block can wrap one or several lines of code. The structure of both variations is described below.

3.3.3. Structure of single-line code blocks

A block is introduced by a left brace ({) followed by a percentage sign (%). The end of a block is defined using a percentage sign (%) followed by a right brace (}).

{% $_foo = "hello world" %}

3.3.4. Structure of multi-line code blocks

Multi-line code blocks are also wrapped by braces and percentage signs ({% …​ %}). However, a multi-line block contains more than one statement. These statements are not separated by the beginning and end of a block. Instead, the individual statements of multi-line blocks are separated by a semicolon (;). if statements are wrapped by braces ({ }).

{%
	if($_a > $_b)
	{
		print("a is greater than b");
	}
%}

3.3.5. Raw blocks

The parser does not check and translate the content of raw blocks. They are displayed in their raw format. Raw blocks need to have a start tag {% raw %} and an end tag {% endraw %}.

{% if $Producer %}
	<dt>Manufacturer</dt>
	<dd>$Producer</dd>
{% endif %}



{% raw %}
	{% if $Producer %}
		<dt>Manufacturer</dt>
		<dd>$Producer</dd>
	{% endif %}
{% endraw %}

3.3.6. Sections

Programming code can be used in web design templates, categories and email templates. Programming code that is inserted outside of a block will not be processed but printed instead.

3.4. Comment

3.4.1. Video tutorial

3.4.2. General information about comments

Comments are used to document the source code or save internal notes. Comments are not visible to outsiders. The compiler ignores comments, i.e., the HTML source code does not contain this information.

Comments can be saved separately or within a code block. The structure of both variations is described below.

3.4.3. Comments in single-line code blocks

A comment is introduced using a left brace ({) followed by a hash/pound sign (). The comment can consist of one or several lines. The end of a comment is signaled using a hash/pound sign () followed by a right brace (}).

3.4.4. Comments in multi-line code blocks

Comments can also be used within multi-line code blocks ({% …​ %}). They are introduced using hash/pound sign (#). Comments within multi-line blocks end automatically at the end of the line and do not need to end with another hash/pound sign.

{%
	$_foo = "hello world"; # This is a comment

	# This is another comment
	print($_foo);
%}

3.5. Types

3.5.1. General information about types

You can use different types of variables in plentymarkets. The following primitive types are currently supported in plentymarkets.

3.5.2. Boolean

This is the most basic type. A Boolean expression is a logical value that can be either TRUE or FALSE.

A Boolean value is specified using the keywords TRUE and FALSE. It is not case-sensitive.

{% $_foo = true; %}

A Boolean is returned by an operator and passed to a control structure.

{% if $_a == 5 %}
	$_a is 5
{% endif %}

3.5.3. Integer

An integer is a value within the range Z = {…​, -2, -1, 0, 1, 2, …​}.

Integers can be signed or unsigned. This is optional for positive numbers, negative numbers must be signed.

{% $_a = 1234; %}

{% $_b = +1234; %}

{% $_c = -123; %}

3.5.4. Float / double

Floats always require a decimal point (.). Thousands separators can not be used.

{% $_a = 1.234; %}

3.5.5. String

A string is defined as a string of characters. Strings must be enclosed in single (') or double (") quotes. These quotes can not be used within the actual string.

{% $_a = "this is a string"; %}

{% if $_a == "this is a string" %}
	$_a contains the value: this is a string
{% endif %}

3.5.6. Array

An array is a list of values assigned to a key (position 0-n). The CMS syntax supports lists of one dimension (value1, value2, value3, …​, value100). A list can consist of different types. A maximum of 100 elements is permitted per array.

{% $_a = [127, 9.49, "plenty"]; %}

3.5.7. Associative array

An associative array is a list of values assigned to an individual key. The CMS syntax supports lists of multiple dimensions. The key always has to be a string. The individual values can be different types.

Technical limitation

Theoretically, there is no limit to the number of nesting levels and elements. However, unusually large constructions can cause errors to occur when displaying or translating data. As such, carefully test your associative arrays and make changes if you notice any unintended behavior.

 
{% $_a = {"plentymarkets":"Welcome to plentymarkets", "name":"John Doe"} %}
$_a["plentymarkets"] $_a["name"].

# Welcome to plentymarkets, John Doe.

3.5.8. NULL

The value NULL represents a variable without a value. NULL is the only possible value of the type NULL.

{% $_a = NULL; %}

3.5.9. Object

An object is a container for other data.

{% $_customerAddress = GetCheckoutCustomerInvoiceAddress() %}
$_customerAddress->Company<br/>
$_customerAddress->FirstName $_customerAddress->LastName<br/>
$_customerAddress->Street $_customerAddress->HouseNo<br/>
$_customerAddress->ZIP $_customerAddress->City<br/>
$_customerAddress->Country

3.6. Variables

3.6.1. General information

A variable is an abstract container for a value. Variables can be defined within the requirements described below.

Structure of variables

Private variables are designated by a Dollar sign ($) followed by an underscore (_) and the name of the variable. Variable names are case-sensitive.

A valid variable name begins with a letter in upper or lower case followed by additional letters or underscores (a-zA-Z_).

Validity

Private variables are only valid within the template in which they were defined (e.g. PageDesignContent, ItemViewSingleItem, etc.). This means that you can define private variables with identical names in different variables without causing conflicts.

Access

No block is necessary to print the contents of private variables. In the example below, a variable is defined and its content is then printed as a header.

{% $_string = "Some title"; %}

<h1>$_string</h1>

A private variable can only be used within the current template. If a value is assigned to a variable in one template, then this value can only be accessed within this same template.

Global private variables are planned for future versions.

Arrays: Individual values, i.e. elements, of arrays can only be accessed when template variables are used. Private variables of the type Array currently primarily serve to pass values to functions.

3.6.2. Assignment

Values can only be assigned within blocks and to private variables. The following data types are supported.

Boolean
{% $_iAmTrue = true; %}

{% $_iAmFalse = false; %}
Integer
{% $_foo1 = 123; %}

{% $_foo2 = +123; %}

{% $_foo3 = -5; %}
Float / double
{% $_positive1 = 9.49; %}

{% $_positive2 = +2.5; %}

{% $_negative = -1.38; %}
String

Strings can be enclosed by single or double quotes. The quote used to enclose the string can not be used within the string itself.

{%
	$_string = "Hello world";

	# concat
	$_string .= " Have a nice day!";
%}
Template variables

You can also assign the content of template variables to private variables.

{% $_foo = $ReferrerID; %}
Array

An array can only consist of one dimension. The individual values of an array can be of different data types.

However, only the following data types are permitted:

  • Integer

  • Double

  • String

  • Boolean

The following array consists of the values 127, 9.49 and the string plenty.

{% $_list = [127, 9.49, "plenty"]; %}
NULL
{% $_nothing = NULL; %}
Container

Containers are functions that return the content of container templates.

{% $_selectionHtml = Container_ItemViewManualSelectionList([15342,583]); %}

3.7. Operators

3.7.1. Arithmetic operators

Do you remember elementary arithmetics from school? Arithmetic operators allow you to perform elementary arithmetics and additional calculations.

Example Name Result

$_a+$_b

Addition

Sum of$_aplus$_b

$_a-$_b

Subtraction

Difference between$_aand$_b

$_a*$_b

Multiplication

Product of$_aand$_b

$_a/$_b

Division

Quotient of$_aand$_b

$_a%$_b

Modulus

Remainder of$_adivided by$_b

$_a*$_b

Power

$_ais the base and$_bthe exponent.
Thus, the result is the power of$_a.

3.7.2. Assignment operators

The most basic assignment operator is "=". One might assume that it stands for "equals". However, this is not the case. Instead, this operator means that the value of the expression on the right is assigned to the operand on the left. Thus, the expression should be read as "is set to the value of".

Single-line code block
{% $_a = 3 %}
{% $_a += 5 %}

{% $_b = "Hello " %}
{% $_b .= "there!" %}
Multi-line code block
{%
	$_a = 3;
	$_a += 5;

	# sets $_a to the value 8 as if we had written: $_a = $_a + 5


	$_b = "Hello ";
	$_b .= "there!";

	# sets $b to the value "Hello there!"
%}
Example Name Result

$_a=$_b

Assignment

$_acontains the value of$_b

$_a.=$_b

Union

A string is extended to include the string in$_b.

$_a+=$_b

Addition

Is equivalent to$_a=$_a+$_b

$_a-=$_b

Subtraction

Is equivalent to$_a=$_a-$_b

$_a*=$_b

Multiplication

Is equivalent to$_a=$_a*$_b

$_a/=$_b

Division

Is equivalent to$_a=$_a/$_b

$_a%=$_b

Modulus

Is equivalent to$_a=$_a%$_b

3.7.3. Relational operators

Example Name Result

$_a==$_b

equal

Returns TRUE if$_aequals$_b.

$_a===$_b

identical

Returns TRUE if$_aequals$_band they are of the same type.

$_a!=$_b

unequal

Returns TRUE if$_adoes not equal$_b.

$_a!==$_b

not identical

Returns TRUE if$_adoes not equal$_bor if they are not of the same type.

$_a<$_b

less than

Returns TRUE if$_ais less than$_b.

$_a>$_b

greater than

Returns TRUE if$_ais greater than$_b.

$_a<=$_b

less than or equal to

Returns TRUE if$_ais less than or equal to$_b.

$_a>=$_b

greater than or equal to

Returns TRUE if$_ais greater than or equal to$_b.

3.7.4. Logical operators

Example Name Result

$_a&&$_b

and

TRUE if both$_aand$_bare TRUE.

$_a

$_b

or

TRUE if at least one of the values of$_aand$_bis TRUE.

!$_a

If more than one logical operator is used within a condition, && operators take precedence over || operators. You can change this order by inserting brackets:

{%
	if( ($_a==$_b || $_a==$_c) && $_c != $_d )
	{

	}
%}

3.7.5. Union operators

The union operator "." concatenates any number of strings, number values, variables and return values of functions to a single string.

Example Name Result

$_a.$_b.$_c

Union

The strings$_a,$_band$_care concatenated.

 
{%
	$_text1 = ["Hello ", "there", "!"];

	print ( $_text1[0] . $_text1[1] . $_text1[2] );
	# returns: Hello there!
%}

{%
	$_name = "there";
	$_text2 = "Hello " . $_name . ".";

	print ( $_text2 );
	# returns: Hello there.
%}

{%
	$_name = "there";
 	$_text3 = "Hello ";
 	$_text3 .= $_x3 . "!";

 	print ( $_text3 );
	# returns: Hello there!
%}

{%
	$_text4 = "Hello, " . $CustomerName;

	print ( $_text4 );
	# returns: Hallo, Marcus Doe
	# $CustomerName contains the customer name after login.
%}

3.7.6. Operator precedence

The operator precedence determines how an operator connects two expressions. Thus, the result of the expression 1 + 5 * 3 equals 16 and not 18 because the multiplication operator (*) precedes the addition operator (+). You can use brackets to influence operator precedence. Thus, (1 + 5) * 3 equals 18. If operators have equal priority, associativity from left to right is used.

The following table shows the operator’s precedence. The operators are listed in descending order. The operator with the highest precedence is at the top.

Associativity Operator

right

!

left

* / %

left

+ - .

no direction

< <= > >=

no direction

== =! === !==

left

&&

left

||

right

= += -= *= /= .= %=

3.8. if

3.8.1. Video tutorial

3.8.2. if

if constructs allow you to display content if specified conditions are met.

if <emExpression</em> <emContent</em>

Content is only displayed if Expression is true. Expression is evaluated to a boolean logical value (TRUE or FALSE). If Expression is evaluated to TRUE, then Content is displayed. If not, Content is ignored.

At its most basic, an if construct consists of only one condition that is introduced using the expression if. The content that follows it is displayed or a function is called.

In single-line code blocks, if constructs must end with the expression endif.

{% if $_a > $_b %}
	a is greater than b
{% endif %}
Alternative
{%
	if($_a > $_b)
	{
 		print("a is greater than b");
	}
%}

3.8.3. else

It is often necessary to run one statement if a specific condition is met and a different statement if that condition is not met. In these cases, else is used. else extends if statements to include an additional statement that is run if the expression within the if statement is evaluated as FALSE. The following programming code returns a is greater than b if the value of$ais greater than the value of$_b. Otherwise, it returns _a is NOT greater than b.

{% if $_a > $_b %}
	a is greater than b
{% else %}
	a is NOT greater than b
{% endif %}
Alternative
{%
	if($_a > $_b)
 	{
		print("a is greater than b");
	}
	else
	{
		print("a is NOT greater than b");
 	}
%}

The else statement is only run when the if expression is evaluated as FALSE.

3.8.4. elseif

elseif is a combination of if and else. Comparable to else, the expression elseif extends an if construct to display alternative content if the original if condition is not met. However, in contrast to else, the alternative content is only displayed if the elseif condition is met. The following example code returns a is greater than b, a equals b or a is less than b:

{% if $_a > $_b %}
	a is greater than b
{% elseif $_a == $_b %}
	a equals b
{% else %}
	a is less than b
{% endif %}
Alternative
{%
	if($_a > $_b)
	{
 		print("a is greater than b");
	}
	elseif($_a == $_b)
	{
 		print("a equals b");
	}
	else
	{
 		print("a is less than b");
	}
%}

Several elseif structures can be used within a single if control structure. The first structure that meets the condition is run.

The elseif part is only run if the previous if condition and all other previous elseif conditions do not apply (FALSE) and if the current elseif condition applies (TRUE).

3.8.5. contains

The contains condition was implemented to take account of specific use cases. With this condition, contents which are contained in a string are displayed. This can also be the case if several individual conditions apply. In such cases, the contains condition allows for simplified notation.

In the following example, payment data is only displayed if $MethodOfPaymentID is contained in the string "1|2|3", i.e. is equivalent to the values 1, 2 or 3. The template variable $MethodOfPaymentID only outputs numbers. This code can be used in email templates.

{% if "1|2|3" contains $MethodOfPaymentID %}
	Payment information for cash on delivery (ID 1), invoice (ID 2) and debit (ID 3)
{% endif %}

3.8.6. Complex expressions

Expressions can also consist of several conditions linked by a logical operator (*&&, || *).

If different conditions are to be grouped together, brackets must be used. Conditions within brackets are evaluated as a group and the result (TRUE or FALSE) is evaluated with the additional conditions.

In the following example, one of the conditions within the brackets must be met. At the same time, $_d must contain the boolean value TRUE. In this example, it is also sufficient that $_b has the value 1 and $_d has the value TRUE.

{% if ( $_a &gt; 0 || $_b &gt; 0 || $_c &gt; 0) &amp;&amp; $_d == TRUE %}
	Content
{% endif %}
Alternative
{%
	if(( $_a > 0 || $_b > 0 || $_c > 0) && $_d == TRUE)
	{
		print("Content");
	}
%}

In the next example the content is displayed both if the value of $_a, $_b or $_c is greater than 0 and if the value of two or all is greater than 0.

{% if $_a &gt; 0 || $_b &gt; 0 || $_c &gt; 0 &amp;&amp; $_d == TRUE %}
	Content
{% endif %}
Alternative
{%
	if($_a &gt; 0 || $_b &gt; 0 || $_c &gt; 0 &amp;&amp; $_d == TRUE)
 	{
		print("Content");
	}
%}

This means that when defining complex expressions, you need to understand the dependencies that exist for the individual conditions to achieve the desired result.

3.9. for

3.9.1. for loop

for loops can be applied by defining a counter variable and a number range. Alternatively, an iteration can be performed through an array.

3.9.2. Video tutorial

3.9.3. Number range

For this variation, a counter variable (in this case$_i) and then a number range (in this case from 1 to 10) need to be defined:

{% for $_i in 1..10 %}
	Hello, I am pass $_i
{% endfor %}
Alternative
{%
	for($_i in 1..10)

	{
		print("Hello, I am pass " .$_i);
	}

	# Output:
	# Hello, I am pass 1
	# Hello, I am pass 2
	# ...
	# Hello, I am pass 10
%}

This variation is optional and can e.g. be used to display item images. Item images are made available within the templates as arrays.

If you have saved more than one but no more than five images for some items, the following loop is an interesting option for displaying images:

{% for $_i in 1..5 %}
	{% if $ImageURL[$_i]!="" %}
		$Image[$_i]
	{% endif %}
{% endfor %}
Alternative
{%
	for($_i in 1..5)
	{
		if($ImageURL[$_i] != "")
		{
			print($Image[$_i]);
		}
	}
%}

3.9.4. Iteration through array

An iteration through an array can be performed in two different ways. Either the value of the current array position is returned or both the position and the value.

{% $_a = ["Hello", "there!", "How", "are", "you", "today?"] %}

{% for $_word in $_a %}
	$_word
{% endfor %}
Alternative
{%
	$_a = ["Hello", "there!", "How", "are", "you", "today?"];

		for($_word in $_a)
		{
			print($_word);
		}

	# Output: Hello there! How are you today?
%}

Use the following loop variation if you want to return the position (in this case$_key) as well:

Iteration through array with loop for single-line code block
{% $_a = ["Hello", "there!", "How", "are", "you", "today?"] %}

{% for $_key, $_word in $_a %}
	Word $_key: $_word
{% endfor %}
Alternative
{%
	for($_key, $_word in $_a)

	{
		print("Word ");
		print($_key);
		print(": ");
		print($_word);
	}

	# Output:
	# Word 1: Hello Word 2: there! ...
%}

3.9.5. Available template variables

The following template variables are available within for loops. If several loops are nested, the numbering is done from outside to inside.

$LoopBreak[1]

$LoopContinue[1]

$LoopIsFirst[1]

$LoopIsLast[1]

$LoopCount[1]

$LoopPosition[1]

$LoopRevPosition[1]

3.10. Template functions

3.10.1. General information

The CMS syntax supports several kinds of functions. These functions can either be used globally or within specific templates.

3.10.2. Global Functions

This section describes the functions that are used in both the web design and email templates.

Some PHP functions have been integrated into the CMS syntax. Their usage corresponds to that directly in PHP.

Open PHP functions

3.10.3. Web design

PageDesign

This section primarily contains link functions that return URLs to specific sections such as categories, home page, shopping cart, etc.

Open PageDesign

Navigation

The functions in this section call various containers for displaying navigation menus (category navigation).

Open navigation

ItemView

The largest number of containers and thus functions are available for displaying items (e.g. product page, search result).

Open ItemView

Category

This section only contains a small number of functions. However, note the function Form() that is used to return forms.

Open Category

3.10.4. email templates

Some link functions are available for using in email templates.

Open email

3.11. Template variables

3.11.1. General information

Template variables are similar to private variables. However, template variables differ in the following ways:

  • The first character of template variables is always a dollar sign ($) followed directly by a capital letter.

  • Template variables are predefined variables that can be used in specific templates. As soon as you insert a template variable into a template, it is automatically filled with the relevant content.

  • The content of template variables can not be overwritten or changed in any way. To manipulate the content, you need to assign it to a private variable.

3.11.2. Validity

There are two different types of template variables:

Global template variables can be used in all templates. Global template variables are only available for web design and categories. You can find these variables in the Global section of the template variables and functions overview.

EN CMS syntax Template Variables 01

Template variables that are assigned to a specific template are only valid within this template. If such a template variable is used in a different template, it can either not be translated or not filled with the correct content.

EN CMS syntax Template Variables 02

3.11.3. Overview

All available template variables are listed in this manual.

Web design

List of all template variables that can be used in the templates for designing your online store.

Open Web design

Email

These template variables can only be used in email templates.

Open email

4. Global

4.1. Table of Contents

  • PHPFunctions — The following PHP functions can also be used in the CMS syntax. Their usage corresponds to that directly in PHP.

4.2. PHPFunctions

4.2.1. Short description

The following PHP functions can also be used in the CMS syntax. Their usage corresponds to that directly in PHP.

4.2.2. Global Template Functions

  • array_key_exists — Checks if a key exists in the array.

  • arsort — Sorts an array in reverse order while maintaining the index association.

  • asort — Sorts an array while maintaining the index association.

  • bin2hex — Returns an ASCII string that contains the parameter’s hexadecimal output.

  • ceil — Returns the next integer that is greater than or equal to the parameter.

  • count — Counts all elements in an array or attributes in an object.

  • curl_close — Ends a cURL session.

  • curl_exec — Runs a cURL session.

  • curl_init — Starts a cURL session.

  • curl_setopt — Sets an option for a cURL transfer.

  • current — Returns the current element in an array.

  • date — Formats a specified local time / date.

  • explode — Splits a string by string to create an array.

  • floor — Returns the next integer that is less than or equal to the parameter.

  • htmlentities — Converts all suitable characters to HTML codes.

  • implode — Combines array elements to a string.

  • in_array — Checks if a value exists in an array.

  • is_array — Checks if the variable is an array.

  • is_numeric — Checks if a variable is a number or a numeric string.

  • is_string — Checks if the variable is of the type String.

  • json_decode — Decodes a JSON character string. The result can be saved to a local template variable.

  • json_encode — Returns the JSON representation of a value.

  • krsort — Sorts an array by keys in reverse order.

  • ksort — Sorts an array by keys.

  • md5 — Calculate a string’s MD5 hash.

  • natcasesort — Sorts an array by natural order ignoring case.

  • natsort — Sorts an array by natural order.

  • nl2br — Inserts HTML line wraps before all line wraps of a string.

  • number_format — Formats a number with grouped thousands.

  • print — Returns the contained value as HTML. Permitted values are a template variable or a string.

  • round — Rounds the first parameter to the number of decimal places specified in the second parameter.

  • rsort — Sorts an array in reverse order.

  • simplexml_load_string — Converts a string to a simpleXML object and returns this object.

  • sort — Sorts an array.

  • str_replace — Replaces all occurrences of a search string by a different string.

  • strip_tags — Removes HTML tags from a string.

  • stripos — Finds the first occurrence of a string ignoring case.

  • strlen — Detects the string length.

  • strpos — Finds the search string’s first occurrence.

  • strtolower — Makes a string lowercase.

  • strtotime — Parses any English date format into a Unix timestamp.

  • strtoupper — Makes all characters of a string uppercase.

  • substr — Returns part of a string.

  • trim — Strips whitespace or other characters from the beginning and end of a string.

4.2.3. Global Template Variables

  • $ENT_COMPAT — Constant: Only converts double quotation marks. Single quotation marks are not converted and remain unchanged.

  • $ENT_QUOTES — Constant: Converts both double and single quotation marks.

4.2.4. array_key_exists

Short description

Checks if a key exists in the array.

Description of this function
array_key_exists( string $_key  , array $_array  ) : bool
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.5. arsort

Short description

Sorts an array in reverse order while maintaining the index association.

Description of this function
arsort( array $_array  ) :
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.6. asort

Short description

Sorts an array while maintaining the index association.

Description of this function
asort( array $_array  ) :
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.7. bin2hex

Short description

Returns an ASCII string that contains the parameter’s hexadecimal output.

Description of this function
bin2hex( string $_binary_string  ) :

4.2.8. ceil

Short description

Returns the next integer that is greater than or equal to the parameter.

Description of this function
ceil( float $_number  ) :

4.2.9. count

Short description

Counts all elements in an array or attributes in an object.

Description of this function
count( array $_array  ) : int
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.10. curl_close

Short description

Ends a cURL session.

Description of this function
curl_close( resource $_resource  ) :
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.11. curl_exec

Short description

Runs a cURL session.

Description of this function
curl_exec( resource $_resource  ) :
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.12. curl_init

Short description

Starts a cURL session.

Description of this function
curl_init( string $_url  ) :
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.13. curl_setopt

Short description

Sets an option for a cURL transfer.

Description of this function
curl_setopt( resource $_resource  , string $_option  , mixed $_value  , boolean false  ) : bool
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.14. current

Short description

Returns the current element in an array.

Description of this function
current( array $_array  ) :
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.15. date

Short description

Formats a specified local time / date.

Description of this function
date( string $_format  , int $_timestamp  ) : string
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.16. explode

Short description

Splits a string by string to create an array.

Description of this function
explode( string $_delimiter  , string $_str  , int $_limit  ) :
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.17. floor

Short description

Returns the next integer that is less than or equal to the parameter.

Description of this function
floor( float $_number  ) :

4.2.18. htmlentities

Short description

Converts all suitable characters to HTML codes.

Description of this function
htmlentities( string $_string  , int $_flags   =  ENT_QUOTES ) : string
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.19. implode

Short description

Combines array elements to a string.

Description of this function
implode( string $_glue  , array $_pieces  ) : string
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.20. in_array

Short description

Checks if a value exists in an array.

Description of this function
in_array( string $_needle  , array $_haystack  ) : bool
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.21. is_array

Short description

Checks if the variable is an array.

Description of this function
is_array( mixed $_var  ) : bool
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.22. is_numeric

Short description

Checks if a variable is a number or a numeric string.

Description of this function
is_numeric( mixed $_var  ) : bool
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.23. is_string

Short description

Checks if the variable is of the type String.

Description of this function
is_string( mixed $_var  ) : bool
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.24. json_decode

Short description

Decodes a JSON character string. The result can be saved to a local template variable.

Description of this function
json_decode( string $_json  ) :
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.25. json_encode

Short description

Returns the JSON representation of a value.

Description of this function
json_encode( mixed $_value  ) : string
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.26. krsort

Short description

Sorts an array by keys in reverse order.

Description of this function
krsort( array $_array  ) :
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.27. ksort

Short description

Sorts an array by keys.

Description of this function
ksort( array $_array  ) :
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.28. md5

Short description

Calculate a string’s MD5 hash.

Description of this function
md5( string $_str  ) :
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.29. natcasesort

Short description

Sorts an array by natural order ignoring case.

Description of this function
natcasesort( array $_array  ) :
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.30. natsort

Short description

Sorts an array by natural order.

Description of this function
natsort( array $_array  ) :
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.31. nl2br

Short description

Inserts HTML line wraps before all line wraps of a string.

Description of this function
nl2br( string $_str  ) :
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.32. number_format

Short description

Formats a number with grouped thousands.

Description of this function
number_format( float $_number  , int $_decimals   =  0 , string $_decPoint   =  '.' , string $_thousandsPoint   =  ',' ) : string
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.33. print

Short description

Returns the contained value as HTML. Permitted values are a template variable or a string.

Description of this function
print( string $_string  ) : string
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.34. round

Short description

Rounds the first parameter to the number of decimal places specified in the second parameter.

Description of this function
round( float $_number  , int $_precision  ) :

4.2.35. rsort

Short description

Sorts an array in reverse order.

Description of this function
rsort( array $_array  ) :
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.36. simplexml_load_string

Short description

Converts a string to a simpleXML object and returns this object.

Description of this function
simplexml_load_string( string $_data  ) :
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.37. sort

Short description

Sorts an array.

Description of this function
sort( array $_array  ) :
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.38. str_replace

Short description

Replaces all occurrences of a search string by a different string.

Description of this function
str_replace( mixed $_search  , mixed $_replace  , mixed $_subject  ) :
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.39. strip_tags

Short description

Removes HTML tags from a string.

Description of this function
strip_tags( string $_str  , string $_allowable_tags  ) :
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.40. stripos

Short description

Finds the first occurrence of a string ignoring case.

Description of this function
stripos( string $_haystack  , string $_needle  , int $_offset  ) : int
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.41. strlen

Short description

Detects the string length.

Description of this function
strlen( string $_string  ) : int
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.42. strpos

Short description

Finds the search string’s first occurrence.

Description of this function
strpos( string $_haystack  , string $_needle  , int $_offset  ) :
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.43. strtolower

Short description

Makes a string lowercase.

Description of this function
strtolower( string $_string  ) : string
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.44. strtotime

Short description

Parses any English date format into a Unix timestamp.

Description of this function
strtotime( string $_time  , int $_now  ) : int
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.45. strtoupper

Short description

Makes all characters of a string uppercase.

Description of this function
strtoupper( string $_string  ) : string
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.46. substr

Short description

Returns part of a string.

Description of this function
substr( string $_string  , int $_start  , int $_length  ) : string
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

4.2.47. trim

Short description

Strips whitespace or other characters from the beginning and end of a string.

Description of this function
trim( string $_string  ) : string
Examples
{%
	$_array = {"Id":"100","Name":"Couch Red","Price":"400 €"};

	if (array_key_exists("Price", $_array))
	{
		print("Der Artikel ".$_array["Name"]." kostet ".$_array["Price"]);
	}
%}

5. Web design

5.1. Table of Contents

  • PageDesign — Use these functions to design the different page layouts. In addition, several variables with globally relevant information are available.

  • Navigation — This section contains information on designing all category navigations and on variables for the current navigation position (categories).

  • ItemView — This section contains information on the functions and variables for designing item layouts, e.g. lists, product pages and the item search.

  • Category — The functions and variables for designing categories of the type Content.

  • CategoryView

  • BlogDesign — This section contains information on the functions and variables for designing blogs and the blog search function.

  • BlogEntry

  • Checkout — This section contains information on the functions and variables for designing the order process, e.g. shopping cart, invoice address and the selection of the payment method.

  • Misc

  • Validator — This section contains information on the functions and variables for designing the validators. Validators check the details customers enter before these are saved. As soon as the order process data is submitted, the relevant validator template is called. For example, if the invoice address is submitted, the template ValidatorCustomerInvoiceAddress is called. If the customer did not fill in any fields of the invoice address that were defined as mandatory in the template, the respective error messages are returned. The data is not saved while error messages are still returned.

5.2. PageDesign

5.2.1. Short description

Use these functions to design the different page layouts. In addition, several variables with globally relevant information are available.

5.2.2. Global Template Functions

  • Button

  • ButtonOpenBasket — Returns the "Open the shopping cart" button.

  • CatOptionList_Level2

  • CategoryLevel2List_CategoryIdLevel1 — Returns a list of all level 2 categories that are assigned to a specific level 1 category. The level 1 category must be specified.

  • CategoryName4URL — Returns the URL conform name of a category. The category ID must be specified.

  • ContractChangeAllowed

  • EMailDirID — Returns the drop-down list for selecting the newsletter.

  • GetGlobal — This template function retrieves global variables.

  • GetRequestVar

  • GetSystemSetting

  • ItemCategoryOption — Returns options for selecting item categories.

  • ItemProducerFilterSelect — Returns options for filtering the item manufacturer.

  • LP — Returns the translation of a text contained in the language package "General texts". This text must have been saved in this language. The translation is displayed based on the template’s language setting.

  • Link — Returns the URL of a category. The category ID must be specified.

  • Link_AjaxBasket — Returns the URL for opening the individual shopping cart. The ID of the HTML element in which the shopping cart’s content is to be loaded must be specified as a parameter.

  • Link_BankData — Returns the URL to the page that contains your bank details. This page must have been set in the Setup » Client » Select client » Online store » Pages menu.

  • Link_Basket — Returns the URL to the shopping cart.

  • Link_BlogHome — Returns the URL to the blog’s homepage.

  • Link_CancellationRights — Returns the URL to the page that contains information about your cancellation rights. This page must have been set in the System » Client » Select client » Online store » Pages menu.

  • Link_Character — Returns the URL to a characteristic. The characteristic ID must be specified.

  • Link_Checkout — Returns the URL to the checkout.

  • Link_Contact — Returns the URL to the page that contains your contact details. This page must have been set in the Setup » Client » Select client » Online store » Pages menu.

  • Link_CrossSellingItem — Returns the URL to the item’s cross-selling items. The ID of the item for which cross-selling items are to be displayed must be specified.

  • Link_Currency — Returns a URL to a different currency. The corresponding currency symbol is displayed with the prices. The currency must be specified as an alphabetical code based on ISO 4217, e.g. USD for the dollar sign $.

  • Link_CustomerRegistration — Returns the URL to the customer registration.

  • Link_FAQ — Returns a URL to a FAQ folder. The folder ID must be specified. The ID is displayed in the CMS » FAQ menu.

  • Link_File — Makes it possible to provide a download URL to a file. The file must be saved in the CMS » Documents menu. In addition, the file ID must be specified. The ID is displayed in the CMS » Documents menu.

  • Link_FilterCharacter — Returns a URL that contains items with a specific characteristic. The characteristic ID must be specified. The IDs are displayed in the System » Item » Characteristics menu.

  • Link_FilterItem — Returns a URL to items that correspond to a filter result.

  • Link_FirstItem_Cat — Returns a URL to the first item of a category. The category ID must be specified.

  • Link_Forum — Returns the URL to the forum’s homepage.

  • Link_Help — Returns the URL to the help page. This page must have been set in the Setup » Client » Select client » Online store » Pages menu.

  • Link_Home — Returns the URL to the online store’s homepage.

  • Link_ImageList — Returns a URL to an item’s image list. The item ID must be specified.

  • Link_Item — Returns a URL to an item’s detailed item layout. The item ID must be specified.

  • Link_ItemInCat — (Deprecated) Please use Link_Item. This function will be removed in the near future.

  • Link_ItemWishlist — Returns the URL to the wish list.

  • Link_Lang — Returns a URL to a different language of the online store. The language must be specified as an ALPHA-2 code based on ISO 3166-1, e.g. de for German.

  • Link_LegalDisclosure — Returns the URL of the legal disclosure page. This page must have been set in the Setup » Client » Select client » Online store » Pages menu.

  • Link_LostPassword — Returns the URL to the page on which customers can request a new password.

  • Link_MyAccount — Returns the URL to the online store’s My account area.

  • Link_OrderConfirmation — Returns the URL to the order confirmation page.

  • Link_PaymentMethods — Returns the URL to the page that contains information about payment methods. This page must have been set in the Setup » Client » Select client » Online store » Pages menu.

  • Link_PicalikeSearch — Returns a URL to the picalike image search. The item image position must be specified. In addition, the picalike search must be activated in the Setup » Client » Settings » Services » picalike menu.

  • Link_Printout — Returns a URL to the print view of a page. The ID of the category that is to be printed must be specified.

  • Link_Printout_Dir — Returns a URL to the print view of a category and the subcategories. The ID of the parent category must be specified.

  • Link_PrivacyPolicy — Returns a URL to the privacy policy. This page must have been set in the Setup » Client » Select client » Online store » Pages menu.

  • Link_Save — Calls the browser function for saving a category. The category ID must be specified.

  • Link_ShippingCosts — Returns the URL to the page that contains information about your shipping costs. This page must have been set in the Setup » Client » Select client » Online store » Pages menu.

  • Link_Store — Returns the URL to a client (store). The IDs are displayed in the Setup » Client » Select client » Settings menu under Webstore ID. Your standard online store has the ID 0. Consecutive IDs starting with ID 1 are allocated to clients (stores).

  • Link_TermsConditions — Returns the URL to the terms and conditions page. This page must have been set in the Setup » Client » Select client » Online store » Pages menu.

  • Link_TinyBasket — Returns the URL to the shopping cart preview.

  • Link_Watchlist — Returns the URL to the watchlist.

  • Link_Webstore — Returns the URL to a client (store).

  • Link_WebstoreCategory — Returns a URL to the category of a client (store). The ID of the client (store) and the ID of the category must be specified.

  • List_Page_Dir — Returns a list with the names of the categories of the next lower level. The ID of the parent category must be specified.

  • MapTemplateVars — Transfers the values of the object passed to template variables with the same name of the template.

  • ResetCategoryId — Ends the display of the category in a different section.

  • SetCategoryId — Allows you to display the information of a specific category in a different section of the online store.

  • SetGlobal — This template function sets global variables. Use this function within the PageDesignPrepareMainColumn template. This ensures that the value is saved before it is used because this template is built first.

5.2.3. Global Template Variables

  • $ActionPositivResult

  • $AddLightboxJS — Displays images in an overlay.

  • $AddShadowboxJS — Displays images in an overlay.

  • $BankAccount — Contains the bank account number as it was entered in the Setup » Settings » Bank menu.

  • $BankAccountOwner — Contains the account holder as it was entered in the Setup » Settings » Bank menu.

  • $BankCode — Contains the sort code as it was entered in the Setup » Settings » Bank menu.

  • $BankIban — Contains the IBAN as it was entered in the Setup » Settings » Bank menu.

  • $BankName — Contains the name of the bank as it was entered in the Setup » Settings » Bank menu.

  • $BankSwift — Contains the BIC as it was entered in the Setup » Settings » Bank menu.

  • $BaseSSLURL4Links — Contains the fixed part of an encrypted URL which is equivalent to the domain.

  • $BaseURL4Links — Contains the fixed part of an unencrypted URL which is equivalent to the domain.

  • $BasketHighestAgeRestriction

  • $BasketHighestAgeRestrictionDynamic

  • $BasketItemQuantity — Contains the number of items in the shopping cart.

  • $BasketItemQuantityDynamic — Contains the number of items in the shopping cart and the dynamic updating of the number of items.

  • $BasketPreviewContainerId — Contains the ID of the HTML element in which the shopping cart preview is displayed.

  • $BasketReservationTimeLeft — Contains the time that the items in the shopping cart will still be reserved.

  • $BasketTotalSeperatorComma — Causes the total value of the items in the shopping cart to be displayed with a comma as decimal separator.

  • $BasketTotalSeperatorCommaDynamic

  • $BasketTotalSeperatorDot — Causes the total value of the items in the shopping cart to be displayed with a dot as decimal separator.

  • $BasketTotalSeperatorDotDynamic

  • $CancellationRights — Contains the online store’s cancellation rights as saved in the Setup » Client » Select client » Online store » Legal information menu.

  • $Canonical — Contains a canonical tag.

  • $CanonicalUrl

  • $Captchar — Contains a captcha.

  • $CompanyCEO — Contains the name of the company’s chief executive officer. The name of the chief executive officer is saved in the Setup » Settings » Master data menu.

  • $CompanyCity — Contains the city of the company’s place of business. The city is saved in the Setup » Settings » Master data menu.

  • $CompanyCountry — Contains the country of the company’s place of business. The country is saved in the Setup » Settings » Master data menu.

  • $CompanyEmail — Contains the company’s email address. The email address is saved in the Setup » Settings » Master data menu.

  • $CompanyFax — Contains the company’s fax number. The fax number is saved in the Setup » Settings » Master data menu.

  • $CompanyFon — Contains the company’s telephone number. The telephone number is saved in the Setup » Settings » Master data menu.

  • $CompanyHotline — Contains the telephone number of the company’s hotline. The hotline number is saved in the Setup » Settings » Master data menu.

  • $CompanyIsSmallBusiness

  • $CompanyName — Contains the company name. The name is saved in the Setup » Settings » Master data menu.

  • $CompanyStreet — Contains the street name of the company’s place of business. The street name is saved in the Setup » Settings » Master data menu.

  • $CompanyVATNumber — Contains the company’s VAT number. The VAT number is saved in the Setup » Settings » Master data menu.

  • $CompanyZIP — Contains the postcode of the company’s place of business. The postcode is saved in the Setup » Settings » Master data menu.

  • $Container_Guestbook — Contains the online store’s guestbook. This includes existing entries and the form for new entries.

  • $Container_MiscCustomerRegistrationForm — Contains a customer registration form.

  • $Container_MiscDatesList — Contains a list of events.

  • $Container_MiscFAQsList — Contains a list of frequently asked questions.

  • $ContentPageTags2BlogTags

  • $ContentPageTags2ItemTags

  • $CouponCode — Contains display of the coupon code entered by the customer and e.g. can be used in the order confirmation.

  • $CrossSellingType — Returns the items of the specified cross-selling relationship. If no type is specified, similar items will be returned.

  • $Currency — Contains the currency that is currently set in the online store.

  • $CurrencySign — Contains the currency symbol that is currently set in the online store.

  • $CurrentBlogEntryTitle — Contains the name of the blog entry that is currently open.

  • $CurrentSingleItemName — Contains the name of the item that is currently open.

  • $CustomerClass — Contains the customer class.

  • $CustomerEmail — Contains the customer’s email address.

  • $CustomerFSK

  • $CustomerID — Contains the customer ID of the customer that is currently logged in.

  • $CustomerName — Contains the customer name.

  • $CustomerShippingCountry — Contains the customer’s country of delivery.

  • $Day — Contains the current day.

  • $Dir

  • $DisplayDocumentsCustomer — Contains documents for which the access right Customers was set in the CMS » Documents menu. Only visitors of the online store who are logged in can see these documents.

  • $DisplayDocumentsPublic — Contains documents for which the access right Public was set in the CMS » Documents menu.

  • $FACTFinderTagCloud — Contains a cloud of the most popular search terms that were entered in the FACTFinder store search.

  • $FacebookLoginButton — Contains the button for logging into the shopping cart using facebook login data. Must be used in combination with FacebookLoginScript.

  • $FacebookLoginScript — Contains a Java script that is necessary for logging into the shop using facebook login data.

  • $FacebookURL — Contains the URL that was saved for facebook in the Setup » Client » Select client » Services » Social Media menu.

  • $FamilienKarteLogin — Contains the HTML form for login for the Family card Hesse.

  • $FilterProducer — Contains a manufacturer filter.

  • $FilterProducerExist — Contains a query to check if a manufacturer filter was selected already.

  • $FilterProducerSize

  • $FormCloseBlank

  • $FormCloseBlogSearch — Closes a search form for the blog.

  • $FormCloseContentSearch — Closes a search form for the content area.

  • $FormCloseCoupon — Closes a coupon form.

  • $FormCloseItemQuickGuide — Closes a form for the item quick search.

  • $FormCloseSearch — Closes a search form.

  • $FormOpenBlank

  • $FormOpenBlogSearch — Opens a search form for the blog.

  • $FormOpenContentSearch — Contains a search form for the content area.

  • $FormOpenCoupon — Opens a coupon form.

  • $FormOpenItemQuickGuide — Opens a form for the item quick search.

  • $FormOpenSearch — Opens a search form.

  • $ForumGroup — Contains the forum group that the customer is assigned to. The group is displayed and set on customers' Customer data tab.

  • $FreeVar[1] …​$FreeVar[25] — Contains a list of the defined constants. The number of constants must be specified for a specific association to be displayed.

  • $GeneralTermsAndConditions — Contains the online store’s terms and conditions as saved in the Setup » Client » Select client » Online store » Legal information menu.

  • $GooglePlusURL — Contains the URL saved for Google+ in the Setup » Client » Select client » Services » Social Media menu.

  • $HTTP_HOST — Contains the server name.

  • $Headers[UserAgent] …​$Headers[UserAgent]

  • $Hour — Variable contains the current hour.

  • $InShopview — Queries if the online store visitor is viewing the online store itself (1) or not (0). Sections that are not part of the online store, e.g. are a blog or a forum.

  • $IsAdminLoggedIn

  • $IsCustomerLoggedIn

  • $IsFirstPageVisit

  • $IsSSL — Contains a query that checks if SSL is active or not.

  • $IsWelcomePage — Queries if the current page is the homepage (true) or not (false).

  • $ItemLinkCloud — Contains an item link cloud.

  • $ItemProducerFilter — Contains check marks to select one or more item manufacturers.

  • $ItemProducerFilterExists

  • $ItemProducerOption — Contains options to select one or more item manufacturers.

  • $ItemQuickGuide — Contains several selection fields for the item quick search.

  • $ItemQuickGuide_Standalone

  • $LandingPage — Contains the query if this is a user’s first visit to the online store.

  • $Lang — Contains the language currently set.

  • $LegalDisclosure — Contains the online store’s legal disclosure as saved in the Setup » Client » Select client » Online store » Legal information menu.

  • $Link_Parent — Returns a URL to the next higher-ranking category. The category ID must be specified.

  • $LiveShoppingEndTime — Contains the time the live shopping offer ends.

  • $LiveShoppingID — Contains the ID of the current live shopping offer.

  • $LiveShoppingPercentRemaining — Contains the percentage of items that are still available in the live shopping offer.

  • $LiveShoppingPercentSold — Contains the percentage of items already sold as part of the live shopping offer.

  • $LiveShoppingPrice — Contains the price of the current live shopping offer.

  • $LiveShoppingPriceOriginal — Contains the original price of the live shopping offer.

  • $LiveShoppingQuantityRemaining — Contains the number of items still available for the live shopping offer.

  • $LiveShoppingQuantitySold — Contains the number of items already sold as part of the live shopping offer.

  • $LiveShoppingStartTime — Contains the time the live shopping offer starts.

  • $LoopBreak[1] …​$LoopBreak[99] — Aborts the loop and jumps to the next loop.

  • $LoopContinue[1] …​$LoopContinue[99] — Skips one element and continues with the next element.

  • $LoopCount[1] …​$LoopCount[99]

  • $LoopIsFirst[1] …​$LoopIsFirst[99] — Specifies if the first element of a loop is currently iterated or not. The loop must be specified. If several loops are nested, the numbering is done from outside to inside.

  • $LoopIsLast[1] …​$LoopIsLast[99] — Specifies if the last element of a loop is currently iterated or not. The loop must be specified. If several loops are nested, the numbering is done from outside to inside.

  • $LoopPosition[1] …​$LoopPosition[99] — Specifies the current position of the iteration.

  • $LoopRevPosition[1] …​$LoopRevPosition[99] — Specifies how many elements are still to be iterated.

  • $Minute — Contains the current minute.

  • $Month — Contains the current month.

  • $PageDesign — Contains the result of a verification of the current PageDesign template, e.g. Content, Custom etc.

  • $PageTitle — Contains the tab title. This variable can be used globally in all templates.

  • $PageTitle4Tracking — Contains the tab title that is analysed by tracking services.

  • $ParamDbText1

  • $ParamDbText2

  • $PayPalAvailable — Contains the result of a verification that checks if PayPal is available.

  • $Port — Contains the port that is used to connect to the server. The port provides information such as if the connection is encrypted or unencrypted.

  • $PriceColumnDiscountPercentage — Contains the percentage value of the graduated price discount saved for the currently logged in customer’s customer class.

  • $PrivacyPolicy — Contains the online store’s privacy policy as saved in the Setup » Client » Select client » Online store » Legal information menu.

  • $ProducerImageList — Contains a list of the manufacturers as images.

  • $ProducerList — Contains a list of the manufacturers.

  • $ReferrerID — Contains the ID of the referrer.

  • $ReferrerName

  • $Request_MaxCatDeep_QuickGuide

  • $Request_OrderShow — Makes it possible to obtain or return individual steps of the order process. The names of the sections must be specified.

  • $Request_QuotedSearchString — Contains the URL-conform variation of a search term.

  • $Request_SearchInDescription — Contains a search term that is searched for within the item description.

  • $Request_SearchPriceRangeStart

  • $Request_SearchPriceRangeStop

  • $Request_SearchProducer

  • $Request_SearchString

  • $Request_ToShow — Contains the name of a section of the online store.

  • $Robots — Contains the search engine tag robots. The tag is specified in the Items » Categories menu in the Settings tab of a category.

  • $SCRIPT_URL — Contains the dynamic part of the URL.

  • $ShowNetPrices

  • $SocialMedia — Contains the URLs that were saved for social media in the Setup » Client » Select client » Services » Social Media menu. However, these are only returned if social media are activated.

  • $StoreCountryID

  • $TrustedShopsId — Contains the Trusted Shops ID.

  • $TrustedShopsRating — Contains the result of the reviews submitted to Trusted Shops.

  • $TrustedShopsRatingAmount — Contains the number of reviews submitted to Trusted Shops.

  • $TrustedShopsRatingEmailButton — Contains the button for submitting a Trusted Shops review. This button can be inserted into emails.

  • $TrustedShopsRatingResult — Contains a list of the reviews submitted to Trusted Shops.

  • $TrustedShopsRatingShopButton — Contains the button for submitting a Trusted Shops review. This button can be inserted into the layout.

  • $TrustedShopsSeal — Contains the Trusted Shops Trustbadge.

  • $TrustedShopsURL — Contains the URL for Trusted Shops. This URL is generated based on the Trusted Shops ID and is provided by Trusted Shops.

  • $TwitterURL — Contains the URL that was saved for Twitter in the Setup » Client » Select client » Services » Social Media menu.

  • $Visitor[OS] …​$Visitor[AgentUncut] — Contains a list of information on the software the visitor uses. There are 3 indices: OS = operating system, Version = version of operating system, Agent = browser.

  • $WebstoreId — Contains the ID of the current client (store).

  • $WebstoreName — Contains the name saved under Name in the Setup » Client » Select client » Settings menu.

  • $WithdrawalForm

  • $Year — Contains the current year.

5.2.4. Button

Description of this function
Button( string $_buttonType  , string $_link  , string $_additionalAttributes  , string $_idSuffix  ) : string

5.2.5. ButtonOpenBasket

Short description

Returns the "Open the shopping cart" button.

Description of this function
ButtonOpenBasket( string $_buttonValue  ) : string

5.2.6. CategoryContentBody

Description of this function
CategoryContentBody( int $_categoryID  ) : string

5.2.7. CatOptionList_Level2

Description of this function
CatOptionList_Level2( int $CurrentCategoryId[Level1]  ) : string

5.2.8. CategoryLevel2List_CategoryIdLevel1

Short description

Returns a list of all level 2 categories that are assigned to a specific level 1 category. The level 1 category must be specified.

Description of this function
CategoryLevel2List_CategoryIdLevel1( int $_categoryID  ) : string

5.2.9. CategoryName4URL

Short description

Returns the URL conform name of a category. The category ID must be specified.

Description of this function
CategoryName4URL( int $_categoryID  ) : string

5.2.10. ContractChangeAllowed

Description of this function
ContractChangeAllowed( int PlentyId  , string NewModuleValue  )

5.2.11. EMailDirID

Short description

Returns the drop-down list for selecting the newsletter.

Description of this function
EMailDirID( int $_emailDirID  ) : string

5.2.12. GetGlobal

Short description

This template function retrieves global variables.

Description of this function
GetGlobal( string $_key  ) :
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}

5.2.13. GetRequestVar

Description of this function
GetRequestVar( string $_key  , string $_source  ) :

5.2.14. GetSystemSetting

Description of this function
GetSystemSetting( string $_key  ) :

5.2.15. ItemCategoryOption

Short description

Returns options for selecting item categories.

Description of this function
ItemCategoryOption( string 'all'  ) : string

5.2.16. ItemProducerFilterSelect

Short description

Returns options for filtering the item manufacturer.

Description of this function
ItemProducerFilterSelect( string "select"  , string "ItemProducerFilterSelectClass"  , array [1,2,3]  ) : string

5.2.17. LP

Short description

Returns the translation of a text contained in the language package "General texts". This text must have been saved in this language. The translation is displayed based on the template’s language setting.

Description of this function
LP( string $_stringToTranslate  ) : string
Short description

Returns the URL of a category. The category ID must be specified.

Description of this function
Link( int $_categoryID  ) : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns the URL for opening the individual shopping cart. The ID of the HTML element in which the shopping cart’s content is to be loaded must be specified as a parameter.

Description of this function
Link_AjaxBasket( string $_basketContainerID  ) : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns the URL to the page that contains your bank details. This page must have been set in the Setup » Client » Select client » Online store » Pages menu.

Description of this function
Link_BankData() : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns the URL to the shopping cart.

Description of this function
Link_Basket() : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns the URL to the blog’s homepage.

Description of this function
Link_BlogHome() : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns the URL to the page that contains information about your cancellation rights. This page must have been set in the Setup » Client » Select client » Online store » Pages menu.

Description of this function
Link_CancellationRights() : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns the URL to a characteristic. The characteristic ID must be specified.

Description of this function
Link_Character( int $_characterID  , string $_characterName  ) : string
Short description

Returns the URL to the checkout.

Description of this function
Link_Checkout( int $_step  ) : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns the URL to the page that contains your contact details. This page must have been set in the Setup » Client » Select client » Online store » Pages menu.

Description of this function
Link_Contact() : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns the URL to the item’s cross-selling items. The ID of the item for which cross-selling items are to be displayed must be specified.

Description of this function
Link_CrossSellingItem( int $_itemID  ) : string
Short description

Returns a URL to a different currency. The corresponding currency symbol is displayed with the prices. The currency must be specified as an alphabetical code based on ISO 4217, e.g. USD for the dollar sign $.

Description of this function
Link_Currency( string 'EUR'  ) : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns the URL to the customer registration.

Description of this function
Link_CustomerRegistration() : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns a URL to a FAQ folder. The folder ID must be specified. The ID is displayed in the CMS » FAQ menu.

Description of this function
Link_FAQ() : string
Short description

Makes it possible to provide a download URL to a file. The file must be saved in the CMS » Documents menu. In addition, the file ID must be specified. The ID is displayed in the CMS » Documents menu.

Description of this function
Link_File( int $_fileID  ) : string
Short description

Returns a URL that contains items with a specific characteristic. The characteristic ID must be specified. The IDs are displayed in the System » Item » Characteristics menu.

Description of this function
Link_FilterCharacter( int $_filterID  ) : string
Short description

Returns a URL to items that correspond to a filter result.

Description of this function
Link_FilterItem( int $_itemID  , int $_filter1ID  , int $_filter2ID  , int $_filter3ID  ) : string
Short description

Returns a URL to the first item of a category. The category ID must be specified.

Description of this function
Link_FirstItem_Cat( int $_categoryID  ) : string
Short description

Returns the URL to the forum’s homepage.

Description of this function
Link_Forum() : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns the URL to the help page. This page must have been set in the Setup » Client » Select client » Online store » Pages menu.

Description of this function
Link_Help() : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns the URL to the online store’s homepage.

Description of this function
Link_Home() : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns a URL to an item’s image list. The item ID must be specified.

Description of this function
Link_ImageList( int $_itemID  ) : string
Short description

Returns a URL to an item’s detailed item layout. The item ID must be specified.

Description of this function
Link_Item( int $_itemID  ) : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

(Deprecated) Please use Link_Item. This function will be removed in the near future.

Description of this function
Link_ItemInCat( int $_itemID  ) : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns the URL to the wish list.

Description of this function
Link_ItemWishlist() : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns a URL to a different language of the online store. The language must be specified as an ALPHA-2 code based on ISO 3166-1, e.g. de for German.

Description of this function
Link_Lang( string 'DE'  ) : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns the URL of the legal disclosure page. This page must have been set in the Setup » Client » Select client » Online store » Pages menu.

Description of this function
Link_LegalDisclosure() : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns the URL to the page on which customers can request a new password.

Description of this function
Link_LostPassword() : string
Short description

Returns the URL to the online store’s My account area.

Description of this function
Link_MyAccount() : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns the URL to the order confirmation page.

Description of this function
Link_OrderConfirmation() : string
Short description

Returns the URL to the page that contains information about payment methods. This page must have been set in the Setup » Client » Select client » Online store » Pages menu.

Description of this function
Link_PaymentMethods() : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns a URL to the picalike image search. The item image position must be specified. In addition, the picalike search must be activated in the Setup » Client » Settings » Services » picalike menu.

Description of this function
Link_PicalikeSearch( int 1  ) : string
Short description

Returns a URL to the print view of a page. The ID of the category that is to be printed must be specified.

Description of this function
Link_Printout( int $_categoryID  , string $PageDesign  ) : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns a URL to the print view of a category and the subcategories. The ID of the parent category must be specified.

Description of this function
Link_Printout_Dir( int $_categoryID  ) : string
Short description

Returns a URL to the privacy policy. This page must have been set in the Setup » Client » Select client » Online store » Pages menu.

Description of this function
Link_PrivacyPolicy() : string
Short description

Calls the browser function for saving a category. The category ID must be specified.

Description of this function
Link_Save( int $_categoryID  , string $PageDesign  ) : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns the URL to the page that contains information about your shipping costs. This page must have been set in the Setup » Client » Select client » Online store » Pages menu.

Description of this function
Link_ShippingCosts() : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns the URL to a client (store). The IDs are displayed in the Setup » Client » Select client » Settings menu under Webstore ID. Your standard online store has the ID 0. Consecutive IDs starting with ID 1 are allocated to clients (stores).

Description of this function
Link_Store( int $WebstoreId  ) : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns the URL to the terms and conditions page. This page must have been set in the Setup » Client » Select client » Online store » Pages menu.

Description of this function
Link_TermsConditions() : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns the URL to the shopping cart preview.

Description of this function
Link_TinyBasket() : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns the URL to the watchlist.

Description of this function
Link_Watchlist() : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns the URL to a client (store).

Description of this function
Link_Webstore( int $WebstoreId  ) : string
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}
Short description

Returns a URL to the category of a client (store). The ID of the client (store) and the ID of the category must be specified.

Description of this function
Link_WebstoreCategory( int $WebstoreId  , int $CurrentCategoryId  , string $Lang  ) : string

5.2.60. List_Page_Dir

Short description

Returns a list with the names of the categories of the next lower level. The ID of the parent category must be specified.

Description of this function
List_Page_Dir( int $_categoryID  ) : string

5.2.61. MapTemplateVars

Short description

Transfers the values of the object passed to template variables with the same name of the template.

Description of this function
MapTemplateVars( object $_item  ) : void
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}

5.2.62. ResetCategoryId

Short description

Ends the display of the category in a different section.

Description of this function
ResetCategoryId() : void
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}

5.2.63. SetCategoryId

Short description

Allows you to display the information of a specific category in a different section of the online store.

Description of this function
SetCategoryId( int $_categoryID  ) : void
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}

5.2.64. SetGlobal

Short description

This template function sets global variables. Use this function within the PageDesignPrepareMainColumn template. This ensures that the value is saved before it is used because this template is built first.

Description of this function
SetGlobal( string $_key  , mixed $_value  ) : void
Examples

{%
	$_value = GetGlobal("useHtmlAvailabilityIcon");
%}



{% if GetGlobal("useHtmlAvailabilityIcon") %}
	<span class="availabilityIcon available-$AvailabilityId" data-plenty="availabilityIcon">
		<span class="first"></span>
		<span class="second"></span>
		<span class="third"></span>
	</span>
{% else %}
	<span class="availabilityImageWrapper">$AvailabilityIcon</span>
{% endif %}

5.3. Navigation

5.3.1. Short description

This section contains information on designing all category navigations and on variables for the current navigation position (categories).

5.3.2. Global Template Functions

5.3.3. Global Template Variables

  • $CATEGORY_TYPE_ALL

  • $CATEGORY_TYPE_CONTENT

  • $CATEGORY_TYPE_ITEMS

  • $CUSTOMER_SALUTATION_COMPANY — Constant returns the form of address "Company".

  • $CUSTOMER_SALUTATION_FAMILY — Constant returns the form of address "Family".

  • $CUSTOMER_SALUTATION_FEMALE — Constant returns the form of address "Ms.".

  • $CUSTOMER_SALUTATION_MALE — Constant returns the form of address "Mr.".

  • $CurrentCategoryDescription1/$CurrentCategoryDescription1[Level1] …​$CurrentCategoryDescription1[Level6] — Returns description 1 of the current category. By specifying a level, the descriptions of the higher-ranking categories can be displayed.

  • $CurrentCategoryDescription2/$CurrentCategoryDescription2[Level1] …​$CurrentCategoryDescription2[Level6] — Returns description 2 of the current category. By specifying a level, the descriptions of the higher-ranking categories can be displayed.

  • $CurrentCategoryID/$CurrentCategoryID[Level1] …​$CurrentCategoryID[Level6] — Returns the ID of the current category. By specifying a level, the IDs of the higher-ranking categories can be displayed.

  • $CurrentCategoryImageUrl — Contains the URL of the first category image. Image 1 is set in a category’s Documents tab.

  • $CurrentCategoryImageUrl2 — Contains the URL of the second category image. Image 2 is set in a category’s Documents tab.

  • $CurrentCategoryName/$CurrentCategoryName[Level1] …​$CurrentCategoryName[Level6] — Returns the name of the current category. By specifying a level, the names of the higher-ranking categories can be displayed.

  • $CurrentCategoryShortDescription/$CurrentCategoryShortDescription[Level1] …​$CurrentCategoryShortDescription[Level6] — Returns the short description of the current category. By specifying a level, the short descriptions of the higher-ranking categories can be displayed.

  • $CurrentCategoryType/$CurrentCategoryType[Level1] …​$CurrentCategoryType[Level6] — Returns the type of the current category, i.e. Content or Item. By specifying a level, the types of the higher-ranking categories can be displayed.

  • $CurrentCategoryURLName/$CurrentCategoryURLName[Level1] …​$CurrentCategoryURLName[Level6] — Returns the URL name of the current category. By specifying a level, the URL names of the higher-ranking categories can be displayed.

  • $CurrentSearchEngine

  • $DeepestCategoryLevelReached — Contains the information if the lowest category level has been reached or not.

  • $FACET_TYPE_DYNAMIC

  • $FACET_TYPE_PRICE

  • $FilterExistsAttributes — Contains the information if the attribute filter has been set or not.

  • $FilterExistsCat3

  • $FilterExistsProducer — Contains the information if a manufacturer filter has been set or not.

  • $Jump2FirstCategoryOfNextLevel — Contains a link to the first category of the subjacent level.

  • $NavigationFacetsActive

  • $SEARCH_ENGINE_DEFAULT

  • $SEARCH_ENGINE_FACETTED_SEARCH

  • $SEARCH_ENGINE_FACTFINDER

  • $SEARCH_ENGINE_FINDOLOGIC

5.3.4. Container_FormCategoryFeedback

Description of this function
Container_FormCategoryFeedback( int $categoryID  ) : string

5.3.5. Container_NavigationBreadcrumbsList

Short description

Returns the breadcrumbs navigation. Also allows you to set some parameters in advance so that they differ from the template settings.

Description of this function
Container_NavigationBreadcrumbsList() : string
Template NavigationBreadcrumbsList
Functions

These functions are available in this container.

GetNavigationBreadcrumbsList() :
NavigationBreadcrumbsListItem
Variables

These variables are available in this container.

  • $BreadcrumbId — Contains the ID of the breadcrumb.

  • $BreadcrumbLevel — Contains the breadcrumb level.

  • $BreadcrumbName — Contains the name of the breadcrumb.

  • $BreadcrumbUrl — Contains the breadcrumb URL.

  • $DeepestBreadcrumbsLevelReached — Contains the information if the breadcrumbs' lowest level has been reached (true) or not (false).

Examples
{% if !$IsWelcomePage %}
	<div class="fullwidth breadcrumbsContainer">

		{% Container_NavigationBreadcrumbsList() %}

	</div>
{% endif %}

5.3.6. Container_NavigationCategories

Short description

Returns the category navigation. Also allows you to set some parameters in advance so that they differ from the template settings.

Description of this function
Container_NavigationCategories(
int $NavigationCategories_OpenLevel  ,
int $NavigationCategories_StartLevel  ,
int $NavigationCategories_EachRow  ,
int $NavigationCategories_Type
) : string
Template NavigationCategories
NavigationCategoriesList
NavigationCategoriesListItem
Functions

These functions are available in this container.

Link_FirstItem() : string
Variables

These variables are available in this container.

  • $CategoryDescription — Contains the description of the current category.

  • $CategoryDescription2

  • $CategoryId — Contains the ID of the current category.

  • $CategoryImage[1] …​$CategoryImage[2] — Returns a category image. This image depends on the image position saved.

  • $CategoryIsCurrent — Contains the information if a category is the current category (true) or not (false).

  • $CategoryIsLastInCurrentLevel

  • $CategoryIsOpen — Contains the information if a category is open (true), e.g. as part of the category path, or not (false).

  • $CategoryItemCount — Contains the number of current items of a category.

  • $CategoryLevel — Contains the current category level.

  • $CategoryName — Contains the name of the current category.

  • $CategoryShortDescription — Contains the short description of the current category.

  • $CategoryType — Contains the type of the current category. The types Content and Item are available.

  • $CategoryUrl — Contains the URL of the current category.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $SubCategoryExists — Contains the information if a subcategory exists (true) or not (false).

  • $setCurrentCategoryAsActive

Examples
{% if !$IsWelcomePage %}
	<div class="fullwidth breadcrumbsContainer">

		{% Container_NavigationBreadcrumbsList() %}

	</div>
{% endif %}

5.3.7. Container_NavigationCategories2

Short description

Returns the category navigation 2. Also allows you to set some parameters in advance so that they differ from the template settings.

Description of this function
Container_NavigationCategories2(
int $NavigationCategories2_OpenLevel  ,
int $NavigationCategories2_StartLevel  ,
int $NavigationCategories2_EachRow  ,
int $NavigationCategories2_Type
) : string
Template NavigationCategories2
NavigationCategories2List
NavigationCategories2ListItem
Functions

These functions are available in this container.

Link_FirstItem() : string
Variables

These variables are available in this container.

  • $CategoryDescription — Contains the description of the current category.

  • $CategoryDescription2

  • $CategoryId — Contains the ID of the current category.

  • $CategoryImage[1] …​$CategoryImage[2] — Returns a category image. This image depends on the image position saved.

  • $CategoryIsCurrent — Contains the information if a category is the current category (true) or not (false).

  • $CategoryIsLastInCurrentLevel

  • $CategoryIsOpen — Contains the information if a category is open (true), e.g. as part of the category path, or not (false).

  • $CategoryItemCount — Contains the number of current items of a category.

  • $CategoryLevel — Contains the current category level.

  • $CategoryName — Contains the name of the current category.

  • $CategoryShortDescription — Contains the short description of the current category.

  • $CategoryType — Contains the type of the current category. The types Content and Item are available.

  • $CategoryUrl — Contains the URL of the current category.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $SubCategoryExists — Contains the information if a subcategory exists (true) or not (false).

  • $setCurrentCategoryAsActive

Examples
{% if !$IsWelcomePage %}
	<div class="fullwidth breadcrumbsContainer">

		{% Container_NavigationBreadcrumbsList() %}

	</div>
{% endif %}

5.3.8. Container_NavigationCategories3

Short description

Returns the category navigation 3. Also allows you to set some parameters in advance so that they differ from the template settings.

Description of this function
Container_NavigationCategories3(
int $NavigationCategories3_OpenLevel  ,
int $NavigationCategories3_StartLevel  ,
int $NavigationCategories3_EachRow  ,
int $NavigationCategories3_Type
) : string
Template NavigationCategories3
NavigationCategories3List
NavigationCategories3ListItem
Functions

These functions are available in this container.

Link_FirstItem() : string
Variables

These variables are available in this container.

  • $CategoryDescription — Contains the description of the current category.

  • $CategoryDescription2

  • $CategoryId — Contains the ID of the current category.

  • $CategoryImage[1] …​$CategoryImage[2] — Returns a category image. This image depends on the image position saved.

  • $CategoryIsCurrent — Contains the information if a category is the current category (true) or not (false).

  • $CategoryIsLastInCurrentLevel

  • $CategoryIsOpen — Contains the information if a category is open (true), e.g. as part of the category path, or not (false).

  • $CategoryItemCount — Contains the number of current items of a category.

  • $CategoryLevel — Contains the current category level.

  • $CategoryName — Contains the name of the current category.

  • $CategoryShortDescription — Contains the short description of the current category.

  • $CategoryType — Contains the type of the current category. The types Content and Item are available.

  • $CategoryUrl — Contains the URL of the current category.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $SubCategoryExists — Contains the information if a subcategory exists (true) or not (false).

  • $setCurrentCategoryAsActive

Examples
{% if !$IsWelcomePage %}
	<div class="fullwidth breadcrumbsContainer">

		{% Container_NavigationBreadcrumbsList() %}

	</div>
{% endif %}

5.3.9. Container_NavigationCategories4

Short description

Returns the category navigation 4. Also allows you to set some parameters in advance so that they differ from the template settings.

Description of this function
Container_NavigationCategories4(
int $NavigationCategories4_OpenLevel  ,
int $NavigationCategories4_StartLevel  ,
int $NavigationCategories4_EachRow  ,
int $NavigationCategories4_Type
) : string
Template NavigationCategories4
NavigationCategories4List
NavigationCategories4ListItem
Functions

These functions are available in this container.

Link_FirstItem() : string
Variables

These variables are available in this container.

  • $CategoryDescription — Contains the description of the current category.

  • $CategoryDescription2

  • $CategoryId — Contains the ID of the current category.

  • $CategoryImage[1] …​$CategoryImage[2] — Returns a category image. This image depends on the image position saved.

  • $CategoryIsCurrent — Contains the information if a category is the current category (true) or not (false).

  • $CategoryIsLastInCurrentLevel

  • $CategoryIsOpen — Contains the information if a category is open (true), e.g. as part of the category path, or not (false).

  • $CategoryItemCount — Contains the number of current items of a category.

  • $CategoryLevel — Contains the current category level.

  • $CategoryName — Contains the name of the current category.

  • $CategoryShortDescription — Contains the short description of the current category.

  • $CategoryType — Contains the type of the current category. The types Content and Item are available.

  • $CategoryUrl — Contains the URL of the current category.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $SubCategoryExists — Contains the information if a subcategory exists (true) or not (false).

  • $setCurrentCategoryAsActive

Examples
{% if !$IsWelcomePage %}
	<div class="fullwidth breadcrumbsContainer">

		{% Container_NavigationBreadcrumbsList() %}

	</div>
{% endif %}

5.3.10. Container_NavigationCategories5

Short description

Returns the category navigation 5. Also allows you to set some parameters in advance so that they differ from the template settings.

Description of this function
Container_NavigationCategories5(
int $NavigationCategories5_OpenLevel  ,
int $NavigationCategories5_StartLevel  ,
int $NavigationCategories5_EachRow  ,
int $NavigationCategories5_Type
) : string
Template NavigationCategories5
NavigationCategories5List
NavigationCategories5ListItem
Functions

These functions are available in this container.

Link_FirstItem() : string
Variables

These variables are available in this container.

  • $CategoryDescription — Contains the description of the current category.

  • $CategoryDescription2

  • $CategoryId — Contains the ID of the current category.

  • $CategoryImage[1] …​$CategoryImage[2] — Returns a category image. This image depends on the image position saved.

  • $CategoryIsCurrent — Contains the information if a category is the current category (true) or not (false).

  • $CategoryIsLastInCurrentLevel

  • $CategoryIsOpen — Contains the information if a category is open (true), e.g. as part of the category path, or not (false).

  • $CategoryItemCount — Contains the number of current items of a category.

  • $CategoryLevel — Contains the current category level.

  • $CategoryName — Contains the name of the current category.

  • $CategoryShortDescription — Contains the short description of the current category.

  • $CategoryType — Contains the type of the current category. The types Content and Item are available.

  • $CategoryUrl — Contains the URL of the current category.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $SubCategoryExists — Contains the information if a subcategory exists (true) or not (false).

  • $setCurrentCategoryAsActive

Examples
{% if !$IsWelcomePage %}
	<div class="fullwidth breadcrumbsContainer">

		{% Container_NavigationBreadcrumbsList() %}

	</div>
{% endif %}

5.3.11. Container_NavigationCategories6

Short description

Returns the category navigation 6. Also allows you to set some parameters in advance so that they differ from the template settings.

Description of this function
Container_NavigationCategories6(
int $NavigationCategories6_OpenLevel  ,
int $NavigationCategories6_StartLevel  ,
int $NavigationCategories6_EachRow  ,
int $NavigationCategories6_Type
) : string
Template NavigationCategories6
NavigationCategories6List
NavigationCategories6ListItem
Functions

These functions are available in this container.

Link_FirstItem() : string
Variables

These variables are available in this container.

  • $CategoryDescription — Contains the description of the current category.

  • $CategoryDescription2

  • $CategoryId — Contains the ID of the current category.

  • $CategoryImage[1] …​$CategoryImage[2] — Returns a category image. This image depends on the image position saved.

  • $CategoryIsCurrent — Contains the information if a category is the current category (true) or not (false).

  • $CategoryIsLastInCurrentLevel

  • $CategoryIsOpen — Contains the information if a category is open (true), e.g. as part of the category path, or not (false).

  • $CategoryItemCount — Contains the number of current items of a category.

  • $CategoryLevel — Contains the current category level.

  • $CategoryName — Contains the name of the current category.

  • $CategoryShortDescription — Contains the short description of the current category.

  • $CategoryType — Contains the type of the current category. The types Content and Item are available.

  • $CategoryUrl — Contains the URL of the current category.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $SubCategoryExists — Contains the information if a subcategory exists (true) or not (false).

  • $setCurrentCategoryAsActive

Examples
{% if !$IsWelcomePage %}
	<div class="fullwidth breadcrumbsContainer">

		{% Container_NavigationBreadcrumbsList() %}

	</div>
{% endif %}

5.3.12. Container_NavigationCategories7

Short description

Returns the category navigation 7. Also allows you to set some parameters in advance so that they differ from the template settings.

Description of this function
Container_NavigationCategories7(
int $NavigationCategories7_OpenLevel  ,
int $NavigationCategories7_StartLevel  ,
int $NavigationCategories7_EachRow  ,
int $NavigationCategories7_Type
) : string
Template NavigationCategories7
NavigationCategories7List
NavigationCategories7ListItem
Functions

These functions are available in this container.

Link_FirstItem() : string
Variables

These variables are available in this container.

  • $CategoryDescription — Contains the description of the current category.

  • $CategoryDescription2

  • $CategoryId — Contains the ID of the current category.

  • $CategoryImage[1] …​$CategoryImage[2] — Returns a category image. This image depends on the image position saved.

  • $CategoryIsCurrent — Contains the information if a category is the current category (true) or not (false).

  • $CategoryIsLastInCurrentLevel

  • $CategoryIsOpen — Contains the information if a category is open (true), e.g. as part of the category path, or not (false).

  • $CategoryItemCount — Contains the number of current items of a category.

  • $CategoryLevel — Contains the current category level.

  • $CategoryName — Contains the name of the current category.

  • $CategoryShortDescription — Contains the short description of the current category.

  • $CategoryType — Contains the type of the current category. The types Content and Item are available.

  • $CategoryUrl — Contains the URL of the current category.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $SubCategoryExists — Contains the information if a subcategory exists (true) or not (false).

  • $setCurrentCategoryAsActive

Examples
{% if !$IsWelcomePage %}
	<div class="fullwidth breadcrumbsContainer">

		{% Container_NavigationBreadcrumbsList() %}

	</div>
{% endif %}

5.3.13. Container_NavigationCategories8

Short description

Returns the category navigation 8. Also allows you to set some parameters in advance so that they differ from the template settings.

Description of this function
Container_NavigationCategories8(
int $NavigationCategories8_OpenLevel  ,
int $NavigationCategories8_StartLevel  ,
int $NavigationCategories8_EachRow  ,
int $NavigationCategories8_Type
) : string
Template NavigationCategories8
NavigationCategories8List
NavigationCategories8ListItem
Functions

These functions are available in this container.

Link_FirstItem() : string
Variables

These variables are available in this container.

  • $CategoryDescription — Contains the description of the current category.

  • $CategoryDescription2

  • $CategoryId — Contains the ID of the current category.

  • $CategoryImage[1] …​$CategoryImage[2] — Returns a category image. This image depends on the image position saved.

  • $CategoryIsCurrent — Contains the information if a category is the current category (true) or not (false).

  • $CategoryIsLastInCurrentLevel

  • $CategoryIsOpen — Contains the information if a category is open (true), e.g. as part of the category path, or not (false).

  • $CategoryItemCount — Contains the number of current items of a category.

  • $CategoryLevel — Contains the current category level.

  • $CategoryName — Contains the name of the current category.

  • $CategoryShortDescription — Contains the short description of the current category.

  • $CategoryType — Contains the type of the current category. The types Content and Item are available.

  • $CategoryUrl — Contains the URL of the current category.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $SubCategoryExists — Contains the information if a subcategory exists (true) or not (false).

  • $setCurrentCategoryAsActive

Examples
{% if !$IsWelcomePage %}
	<div class="fullwidth breadcrumbsContainer">

		{% Container_NavigationBreadcrumbsList() %}

	</div>
{% endif %}

5.3.14. Container_NavigationCategories9

Short description

Returns the category navigation 9. Also allows you to set some parameters in advance so that they differ from the template settings.

Description of this function
Container_NavigationCategories9(
int $NavigationCategories9_OpenLevel  ,
int $NavigationCategories9_StartLevel  ,
int $NavigationCategories9_EachRow  ,
int $NavigationCategories9_Type
) : string
Template NavigationCategories9
NavigationCategories9List
NavigationCategories9ListItem
Functions

These functions are available in this container.

Link_FirstItem() : string
Variables

These variables are available in this container.

  • $CategoryDescription — Contains the description of the current category.

  • $CategoryDescription2

  • $CategoryId — Contains the ID of the current category.

  • $CategoryImage[1] …​$CategoryImage[2] — Returns a category image. This image depends on the image position saved.

  • $CategoryIsCurrent — Contains the information if a category is the current category (true) or not (false).

  • $CategoryIsLastInCurrentLevel

  • $CategoryIsOpen — Contains the information if a category is open (true), e.g. as part of the category path, or not (false).

  • $CategoryItemCount — Contains the number of current items of a category.

  • $CategoryLevel — Contains the current category level.

  • $CategoryName — Contains the name of the current category.

  • $CategoryShortDescription — Contains the short description of the current category.

  • $CategoryType — Contains the type of the current category. The types Content and Item are available.

  • $CategoryUrl — Contains the URL of the current category.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $SubCategoryExists — Contains the information if a subcategory exists (true) or not (false).

  • $setCurrentCategoryAsActive

Examples
{% if !$IsWelcomePage %}
	<div class="fullwidth breadcrumbsContainer">

		{% Container_NavigationBreadcrumbsList() %}

	</div>
{% endif %}

5.3.15. Container_NavigationCategories10

Short description

Returns the category navigation 10. Also allows you to set some parameters in advance so that they differ from the template settings.

Description of this function
Container_NavigationCategories10(
int $NavigationCategories10_OpenLevel  ,
int $NavigationCategories10_StartLevel  ,
int $NavigationCategories10_EachRow  ,
int $NavigationCategories10_Type
) : string
Template NavigationCategories10
NavigationCategories10List
NavigationCategories10ListItem
Functions

These functions are available in this container.

Link_FirstItem() : string
Variables

These variables are available in this container.

  • $CategoryDescription — Contains the description of the current category.

  • $CategoryDescription2

  • $CategoryId — Contains the ID of the current category.

  • $CategoryImage[1] …​$CategoryImage[2] — Returns a category image. This image depends on the image position saved.

  • $CategoryIsCurrent — Contains the information if a category is the current category (true) or not (false).

  • $CategoryIsLastInCurrentLevel

  • $CategoryIsOpen — Contains the information if a category is open (true), e.g. as part of the category path, or not (false).

  • $CategoryItemCount — Contains the number of current items of a category.

  • $CategoryLevel — Contains the current category level.

  • $CategoryName — Contains the name of the current category.

  • $CategoryShortDescription — Contains the short description of the current category.

  • $CategoryType — Contains the type of the current category. The types Content and Item are available.

  • $CategoryUrl — Contains the URL of the current category.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $SubCategoryExists — Contains the information if a subcategory exists (true) or not (false).

  • $setCurrentCategoryAsActive

Examples
{% if !$IsWelcomePage %}
	<div class="fullwidth breadcrumbsContainer">

		{% Container_NavigationBreadcrumbsList() %}

	</div>
{% endif %}

5.3.16. Container_NavigationCategoriesStepByStepList

Short description

Returns the reloading category list. Also allows you to set some parameters in advance so that they differ from the template settings.

Description of this function
Container_NavigationCategoriesStepByStepList(
int $NavigationCategoriesStepByStepList_EachRow  ,
int $NavigationCategoriesStepByStepList_Type
) : string
Template NavigationCategoriesStepByStepList
NavigationCategoriesStepByStepListItem
Functions

These functions are available in this container.

Link_FirstItem() : string
Variables

These variables are available in this container.

  • $CategoryDescription — Contains the description of the current category.

  • $CategoryId — Contains the ID of the current category.

  • $CategoryImage[1] …​$CategoryImage[2] — Returns a category image. This image depends on the image position saved.

  • $CategoryItemCount — Contains the number of current items of a category.

  • $CategoryName — Contains the name of the current category.

  • $CategoryShortDescription — Contains the short description of the current category.

  • $CategoryType — Contains the type of the current category. The types Content and Item are available.

  • $CategoryUrl — Contains the URL of the current category.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $SubCategoryExists — Contains the information if a subcategory exists (true) or not (false).

  • $SubCategoryList — Contains a list of the current category’s subcategories.

  • $setCurrentCategoryAsActive

Examples
{% if !$IsWelcomePage %}
	<div class="fullwidth breadcrumbsContainer">

		{% Container_NavigationBreadcrumbsList() %}

	</div>
{% endif %}

5.3.17. Container_NavigationCategoriesStepByStepList2

Short description

Returns the second reloading category list. Also allows you to set some parameters in advance so that they differ from the template settings.

Description of this function
Container_NavigationCategoriesStepByStepList2(
int $NavigationCategoriesStepByStepList2_EachRow  ,
int $NavigationCategoriesStepByStepList2_Type
) : string
Template NavigationCategoriesStepByStepList2
NavigationCategoriesStepByStepList2Item
Functions

These functions are available in this container.

Link_FirstItem() : string
Variables

These variables are available in this container.

  • $CategoryDescription — Contains the description of the current category.

  • $CategoryId — Contains the ID of the current category.

  • $CategoryImage[1] …​$CategoryImage[2] — Returns a category image. This image depends on the image position saved.

  • $CategoryItemCount — Contains the number of current items of a category.

  • $CategoryName — Contains the name of the current category.

  • $CategoryShortDescription — Contains the short description of the current category.

  • $CategoryType — Contains the type of the current category. The types Content and Item are available.

  • $CategoryUrl — Contains the URL of the current category.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $SubCategoryExists — Contains the information if a subcategory exists (true) or not (false).

  • $SubCategoryList — Contains a list of the current category’s subcategories.

  • $setCurrentCategoryAsActive

Examples
{% if !$IsWelcomePage %}
	<div class="fullwidth breadcrumbsContainer">

		{% Container_NavigationBreadcrumbsList() %}

	</div>
{% endif %}

5.3.18. Container_NavigationCategoriesSublevelSelect

Short description

Returns the category navigation in drop-down lists. Also allows you to set some parameters in advance so that they differ from the template settings.

Description of this function
Container_NavigationCategoriesSublevelSelect( int $NavigationCategoriesSublevelSelect_Type  ) : string
Template NavigationCategoriesSublevelSelect
Variables

These variables are available in this container.

  • $SubLevelExist — Contains the information if a subcategory level exists (true) or not (false).

  • $SubLevelSelect — Contains a drop-down list with the subcategories of the next level.

5.3.19. Container_NavigationFacetsList

Description of this function
Container_NavigationFacetsList() : string
Template NavigationFacetsList
NavigationFacetsListItem
Variables

These variables are available in this container.

  • $FacetCSSClass

  • $FacetID

  • $FacetName

  • $FacetPosition

  • $FacetType

NavigationFacetValuesListItem
Variables

These variables are available in this container.

  • $FacetValueCSSClass

  • $FacetValueID

  • $FacetValueImageURL

  • $FacetValueIsActive

  • $FacetValueItemCount

  • $FacetValueMaxPrice

  • $FacetValueMinPrice

  • $FacetValueName

  • $FacetValuePosition

  • $FacetValueSelectedMaxPrice

  • $FacetValueSelectedMinPrice

5.3.20. FindologicFilterContainer

Short description

Returns the filters returned by Findologic.

Description of this function
FindologicFilterContainer() : string

5.3.21. FindologicHeader

Description of this function
FindologicHeader() : string

5.3.22. GetNavigationBreadcrumbsList

Description of this function
GetNavigationBreadcrumbsList() :

5.3.23. GetNavigationCategories2List

Description of this function
GetNavigationCategories2List(
int $NavigationCategories2_OpenLevel  ,
int $NavigationCategories2_StartLevel  ,
int $NavigationCategories2_EachRow  ,
int $NavigationCategories2_Type
) :

5.3.24. GetNavigationCategories3List

Description of this function
GetNavigationCategories3List(
int $NavigationCategories3_OpenLevel  ,
int $NavigationCategories3_StartLevel  ,
int $NavigationCategories3_EachRow  ,
string $NavigationCategories3_Type
) :

5.3.25. GetNavigationCategories4List

Description of this function
GetNavigationCategories4List(
int $NavigationCategories4_OpenLevel  ,
int $NavigationCategories4_StartLevel  ,
int $NavigationCategories4_EachRow  ,
int $NavigationCategories4_Type
) :

5.3.26. GetNavigationCategories5List

Description of this function
GetNavigationCategories5List(
int $NavigationCategories5_OpenLevel  ,
int $NavigationCategories5_StartLevel  ,
int $NavigationCategories5_EachRow  ,
int $NavigationCategories5_Type
) :

5.3.27. GetNavigationCategories6List

Description of this function
GetNavigationCategories6List(
int $NavigationCategories6_OpenLevel  ,
int $NavigationCategories6_StartLevel  ,
int $NavigationCategories6_EachRow  ,
int $NavigationCategories6_Type
) :

5.3.28. GetNavigationCategories7List

Description of this function
GetNavigationCategories7List(
int $NavigationCategories7_OpenLevel  ,
int $NavigationCategories7_StartLevel  ,
int $NavigationCategories7_EachRow  ,
int $NavigationCategories7_Type
) :

5.3.29. GetNavigationCategories8List

Description of this function
GetNavigationCategories8List(
int $NavigationCategories8_OpenLevel  ,
int $NavigationCategories8_StartLevel  ,
int $NavigationCategories8_EachRow  ,
int $NavigationCategories8_Type
) :

5.3.30. GetNavigationCategories9List

Description of this function
GetNavigationCategories9List(
int $NavigationCategories9_OpenLevel  ,
int $NavigationCategories9_StartLevel  ,
int $NavigationCategories9_EachRow  ,
int $NavigationCategories9_Type
) :

5.3.31. GetNavigationCategories10List

Description of this function
GetNavigationCategories10List(
int $NavigationCategories10_OpenLevel  ,
int $NavigationCategories10_StartLevel  ,
int $NavigationCategories10_EachRow  ,
int $NavigationCategories10_Type
) :

5.3.32. GetNavigationCategoriesList

Description of this function
GetNavigationCategoriesList(
int $NavigationCategories_OpenLevel  ,
int $NavigationCategories_StartLevel  ,
int $NavigationCategories_EachRow  ,
int $NavigationCategories_Type
) :

5.3.33. GetNavigationCategoriesStepByStepList

Description of this function
GetNavigationCategoriesStepByStepList(
int $NavigationCategoriesStepByStepList_EachRow  ,
int $NavigationCategoriesStepByStepList_Type
) :

5.3.34. GetNavigationCategoriesStepByStepList2

Description of this function
GetNavigationCategoriesStepByStepList2(
int $NavigationCategoriesStepByStepList2_EachRow  ,
int $NavigationCategoriesStepByStepList2_Type
) :

5.3.35. GetNavigationFacetValuesList

Description of this function
GetNavigationFacetValuesList( int $_facetID  , boolean $_ignoreCurrentResult  ) :

5.3.36. GetNavigationFacetValuesListByCategory

Description of this function
GetNavigationFacetValuesListByCategory( int $_facetID  , int $_categoryID  ) :

5.3.37. GetNavigationFacetsList

Description of this function
GetNavigationFacetsList( boolean $_ignoreCurrentResult  ) :

5.3.38. GetNavigationFacetsListByFacetIDs

Description of this function
GetNavigationFacetsListByFacetIDs( array $_facetID  , boolean $_ignoreCurrentResult  ) :

5.3.39. GetNavigationPriceFacet

Description of this function
GetNavigationPriceFacet( boolean $_ignoreCurrentResult  ) : object
Description of this function
Link_ActivateFacetValue( int $_facetValueID  , boolean $_ignoreCurrentResult  , int $CurrentCategoryId  ) : string
Description of this function
Link_DeactivateFacetValue( int $_facetValueID  ) : string
Description of this function
Link_ResetFacetCategory( int $_facetID  ) : string

5.3.43. NavigationFacetsListAvailable

Description of this function
NavigationFacetsListAvailable( boolean $_ignoreCurrentResult  ) : bool

5.4. ItemView

5.4.1. Short description

This section contains information on the functions and variables for designing item layouts, e.g. lists, product pages and the item search.

5.4.2. Global Template Functions

5.4.3. Templates

5.4.4. Global Template Variables

  • $CHANGE_VIEW_TO_FURTHER_ITEMS_LIST — Is a constant for changing the item view. Is equivalent to the setting ItemViewFurtherItemsList.

  • $CHANGE_VIEW_TO_FURTHER_ITEMS_LIST2 — Is a constant for changing the item view. Is equivalent to the setting ItemViewFurtherItemsList2.

  • $CHANGE_VIEW_TO_FURTHER_ITEMS_LIST3 — Is a constant for changing the item view. Is equivalent to the setting ItemViewFurtherItemsList3.

  • $CHANGE_VIEW_TO_FURTHER_ITEMS_LIST4 — Is a constant for changing the item view. Is equivalent to the setting ItemViewFurtherItemsList4.

  • $CHANGE_VIEW_TO_FURTHER_ITEMS_LIST5 — Is a constant for changing the item view. Is equivalent to the setting ItemViewFurtherItemsList5.

  • $CHANGE_VIEW_TO_FURTHER_ITEMS_LIST6 — Is a constant for changing the item view. Is equivalent to the setting ItemViewFurtherItemsList6.

  • $CurrentItemId — Contains the current item’s ID.

  • $CurrentPage — Contains the current page’s page number.

  • $GROUP_ITEMS_BY_ATTRIBUTES — Is a constant for grouping items in the item category view. Is equivalent to the setting Grouping by attributes.

  • $GROUP_ITEMS_BY_VARIANT — Is a constant for grouping items in the item category view. Is equivalent to the setting Grouping by variations.

  • $GROUP_ITEMS_NO — Is a constant for variation grouping the item category view. Is equivalent to the setting No grouping.

  • $ITEM_SORTING_ID_DESC — Is a constant for sorting items. Is equivalent to the setting Item ID descending.

  • $ITEM_SORTING_NAME_ASC — Is a constant for sorting items. Is equivalent to the setting Item name ascending.

  • $ITEM_SORTING_NAME_DESC — Is a constant for sorting items. Is equivalent to the setting Item name descending.

  • $ITEM_SORTING_POSITION_ASC — Is a constant for sorting items. Is equivalent to the setting Item position ascending.

  • $ITEM_SORTING_POSITION_DESC — Is a constant for sorting items. Is equivalent to the setting Item position descending.

  • $ITEM_SORTING_PRICE_ASC — Is a constant for sorting items. Is equivalent to the setting Price in ascending order.

  • $ITEM_SORTING_PRICE_DESC — Is a constant for sorting items. Is equivalent to the setting Price in descending order.

  • $ITEM_SORTING_PRODUCER_NAME_ASC — Is a constant for sorting items. Is equivalent to the setting Manufacturer name ascending.

  • $ITEM_SORTING_PUBLICATION_DATE_ASC

  • $ITEM_SORTING_PUBLICATION_DATE_DESC

  • $ITEM_SORTING_RANDOM — Is a constant for sorting items. Is equivalent to the setting item_random and means items are sorted randomly.

  • $ITEM_SORTING_RELEASE_DATE_ASC — Is a constant for sorting items. Is equivalent to the setting Release date ascending.

  • $ITEM_SORTING_RELEASE_DATE_DESC — Is a constant for sorting items. Is equivalent to the setting Release date descending.

5.4.5. Container_FormItemFeedback

Short description

Returns the template FormItemFeedback. This template is used to display a form in which customers can give feedback on items.

Description of this function
Container_FormItemFeedback( int $itemID  ) : string

5.4.6. Container_ItemViewAdvancedOrderItemsList

Short description

Returns the template ItemViewAdvancedOrderItemsList. This template is used to display a list of preordered items.

Description of this function
Container_ItemViewAdvancedOrderItemsList(
int $ItemViewAdvancedOrderItemsList_EachRow  ,
int $ItemViewAdvancedOrderItemsList_Limit  ,
int $ItemViewAdvancedOrderItemsList_OnlyOfCurrentCategory
) : string
Template ItemViewAdvancedOrderItemsList
Variables

These variables are available in this container.

  • $Subcategoryselect — Contains a drop-down list of the subcategories of the next level.

ItemViewAdvancedOrderItemsListItem
Functions

These functions are available in this container.

ButtonAddBasket1Small( string $_buttonValue  ) : string
ButtonAddBasketOverlay( string $_buttonValue  ) : string
GetBarcode( string $_barcodeName  ) : string
GetDocumentLinks( string '$_fileExtension'  ) :
GetItemViewStockList( int $ID  ) :
Link_CurrentCategory() : string
Variables

These variables are available in this container.

  • $ASIN — Contains an item’s first Amazon Standard Ident Number (ASIN).

  • $ActionId — Contains the online store special’s ID.

  • $AttributeExist — Contains a query that checks if an item has attributes.

  • $AttributeMatrix — Contains all variations of an item. These are displayed in a table in which customers can also enter the order quantity. Insert the variable in the section between FormOpenOrder and FormCloseOrder for the entered order quantity to be placed in the shopping cart. We recommend that you use the variable for a small number of attributes and attribute values only.

  • $AttributeSelect — Contains one drop-down list per attribute that contains an item’s attribute values. The attribute name is displayed above the drop-down list. The attribute values can be selected in a drop-down list.

  • $AttributeSelectWithoutAttributeName — Contains one drop-down list per attribute that contains the item’s attribute values.

  • $AvailabilityIcon — Contains the availability icon for the item availability. An icon is saved in the Setup » Item » Availability menu.

  • $AvailabilityId — Contains the ID of the item availability (1-10).

  • $AvailabilityString — Contains the name of the item availability. The names are saved in the Setup » Item » Availability menu.

  • $BasePrice — Contains an item’s unit price.

  • $BasePriceLot — Contains the price of an item’s sales unit.

  • $BasePriceUnit — Contains the unit for the unit price.

  • $CategoryId[Level1] …​$CategoryId[Level6] — Contains the ID of the item’s default category.

  • $CategoryName[Level1] …​$CategoryName[Level6] — Contains the name of the category.

  • $Condition — Contains the item condition.

  • $CreationDate — Contains an item’s creation date.

  • $DefaultShippingCost

  • $Description — Contains the item text.

  • $DescriptionShort — Contains the item preview text.

  • $EAN — Contains an item’s EAN 1.

  • $ExpirationDate — Contains an item’s expiration date ("available until").

  • $FSK — Contains an item’s age rating.

  • $FlashHeight — Contains the height of an item’s flash file.

  • $FlashURL — Contains the URL of an item’s flash file.

  • $FlashWidth — Contains the width of an item’s flash file.

  • $FormCloseOrder — Contains an item’s closing HTML form.

  • $FormOpenOrder — Contains an item’s opening HTML form.

  • $Free[1] …​$Free[20] — Contains the item free text fields.

  • $Height — Contains an item’s height.

  • $ID — Contains the item ID.

  • $ISBN — Contains the item’s International Standard Book Number (ISBN).

  • $Image[1] …​$Image[25] — HTML image tag of the images with the highest resolution.

  • $ImageAlt[1] …​$ImageAlt[25] — Contains the item image’s alternative text.

  • $ImageAttributeList — Contains an item’s attribute values as images. The images are linked to the attribute values in the item’s Images tab.

  • $ImageName[1] …​$ImageName[25] — Contains the item image’s name.

  • $ImageURL[1] …​$ImageURL[25] — URL of the images with the highest resolution.

  • $ItemAge — Contains an item’s age in days, starting from the date it was created in plentymarkets.

  • $ItemShipping[1] …​$ItemShipping[2] — Contains the item’s shipping costs.

  • $Length — Contains an item’s length.

  • $LimitOrderByStock — Contains the value for limiting the item to the stock; 0 = No limitation, 1 = Limited to net stock, 2 = Do not administer stock for this item.

  • $Lot — Contains the content of an item’s sales unit.

  • $MiddleSizeImage[1] …​$MiddleSizeImage[25] — HTML image tag of the images with medium resolution.

  • $MiddleSizeImageURL[1] …​$MiddleSizeImageURL[25] — URL of the images with medium resolution.

  • $Model — Model

  • $Name[1] …​$Name[3] — Contains the item name.

  • $Name4URL — Contains the URL-conform item name.

  • $Number — Contains the item number.

  • $OrderQuantityInterval

  • $OrderQuantityMax — Contains the item’s maximum order quantity.

  • $OrderQuantityMin — Contains the item’s minimum order quantity.

  • $PackagingUnit — Contains an item’s packaging unit.

  • $Position

  • $PreviewImage[1] …​$PreviewImage[25] — Returns the current item’s preview image.

  • $PreviewImageURL[1] …​$PreviewImageURL[25] — Returns the URL of the current item’s preview image.

  • $Price — Contains an item’s price.

  • $PriceCount — Contains the number of an item’s price sets.

  • $PriceDecimalSeparatorDot — Contains an item’s price; decimal separator is a dot.

  • $PriceDynamic — Contains the price of an item or of a variation including surcharges etc. When using this variable, the item price is automatically adjusted based on the variation selected.

  • $PriceID — Contains the ID of the item’s price set.

  • $PriceRadioButton — All price sets are displayed and selected using radio buttons.

  • $PriceSelect — Selection of all price sets as HTML select.

  • $Producer — Contains the name of the item manufacturer.

  • $ProducerAddressCity

  • $ProducerAddressCountryID

  • $ProducerAddressCountryName

  • $ProducerAddressHouseNo

  • $ProducerAddressStreet

  • $ProducerAddressZip

  • $ProducerEmail

  • $ProducerExternalName

  • $ProducerFax

  • $ProducerLogo — Contains the manufacturer logo.

  • $ProducerPhone

  • $ProducerURL — Contains the URL of the manufacturer. The URL is saved in the manufacturer data set.

  • $RRP — Contains the item’s recommended retail price.

  • $RRPDecimalSeparatorDot — Contains the recommended retail price; decimal separator is a dot.

  • $Rating — Contains the feedback.

  • $RatingCount — Contains the number of feedbacks for an item.

  • $RatingImage — Contains the average feedback.

  • $RatingMax

  • $RebateAvailable — Contains a query that checks whether a discounted price exists for an item that the customer is eligible for.

  • $ReleaseDate — Contains the item’s release date.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $Saving — Contains the discount amount.

  • $SavingDecimalSeparatorDot — Contains the discount amount; decimal separator is a dot.

  • $SavingDynamic

  • $SavingDynamicDecimalSeparatorDot

  • $SavingDynamicPercent

  • $SavingPercent — Contains the discount rate in percent.

  • $SecondPreviewImage[1] …​$SecondPreviewImage[25] — Returns the current item’s second preview image.

  • $SecondPreviewImageURL[1] …​$SecondPreviewImageURL[25] — Returns the URL of the current item’s second preview image.

  • $ShortName — Contains a shorter version of the item name. The item name is truncated after a specific number of characters.

  • $Size — Contains the information in Unit 1 and Unit 2 of an item’s Base tab.

  • $StockList — Contains an item’s physical stock.

  • $TechnicalData — Contains the item’s technical data.

  • $UnitString/$UnitString[1] …​$UnitString[2] — Contains the item unit.

  • $VAT — Contains the item’s VAT in percent.

  • $VATHint — Contains the VAT note, e.g. "incl. statutory VAT".

  • $VariationID — Contains the variation’s ID.

  • $VolumePrice[1] …​$VolumePrice[10] — Contains the price for an item’s minimum order quantity.

  • $VolumePriceStartingQuantity[1] …​$VolumePriceStartingQuantity[10] — Contains the minimum order quantity for a discount to be applied to an item.

  • $Volumen — Contains an item’s volume.

  • $Weight — Contains an item’s weight.

  • $WeightNet — Contains an item’s net weight.

  • $Width — Contains an item’s width.

5.4.7. Container_ItemViewAdvancedOrderItemsList2

Short description

Returns the template ItemViewAdvancedOrderItemsList2. This template is used to display a list of preordered items.

Description of this function
Container_ItemViewAdvancedOrderItemsList2(
int $ItemViewAdvancedOrderItemsList2_EachRow  ,
int $ItemViewAdvancedOrderItemsList2_Limit  ,
int $ItemViewAdvancedOrderItemsList2_OnlyOfCurrentCategory
) : string
Template ItemViewAdvancedOrderItemsList2
Variables

These variables are available in this container.

  • $Subcategoryselect — Contains a drop-down list of the subcategories of the next level.

ItemViewAdvancedOrderItemsList2Item
Functions

These functions are available in this container.

ButtonAddBasket1Small( string $_buttonValue  ) : string
ButtonAddBasketOverlay( string $_buttonValue  ) : string
GetBarcode( string $_barcodeName  ) : string
GetDocumentLinks( string '$_fileExtension'  ) :
GetItemViewStockList( int $ID  ) :
Link_CurrentCategory() : string
Variables

These variables are available in this container.

  • $ASIN — Contains an item’s first Amazon Standard Ident Number (ASIN).

  • $ActionId — Contains the online store special’s ID.

  • $AttributeExist — Contains a query that checks if an item has attributes.

  • $AttributeMatrix — Contains all variations of an item. These are displayed in a table in which customers can also enter the order quantity. Insert the variable in the section between FormOpenOrder and FormCloseOrder for the entered order quantity to be placed in the shopping cart. We recommend that you use the variable for a small number of attributes and attribute values only.

  • $AttributeSelect — Contains one drop-down list per attribute that contains an item’s attribute values. The attribute name is displayed above the drop-down list. The attribute values can be selected in a drop-down list.

  • $AttributeSelectWithoutAttributeName — Contains one drop-down list per attribute that contains the item’s attribute values.

  • $AvailabilityIcon — Contains the availability icon for the item availability. An icon is saved in the Setup » Item » Availability menu.

  • $AvailabilityId — Contains the ID of the item availability (1-10).

  • $AvailabilityString — Contains the name of the item availability. The names are saved in the Setup » Item » Availability menu.

  • $BasePrice — Contains an item’s unit price.

  • $BasePriceLot — Contains the price of an item’s sales unit.

  • $BasePriceUnit — Contains the unit for the unit price.

  • $CategoryId[Level1] …​$CategoryId[Level6] — Contains the ID of the item’s default category.

  • $CategoryName[Level1] …​$CategoryName[Level6] — Contains the name of the category.

  • $Condition — Contains the item condition.

  • $CreationDate — Contains an item’s creation date.

  • $DefaultShippingCost

  • $Description — Contains the item text.

  • $DescriptionShort — Contains the item preview text.

  • $EAN — Contains an item’s EAN 1.

  • $ExpirationDate — Contains an item’s expiration date ("available until").

  • $FSK — Contains an item’s age rating.

  • $FlashHeight — Contains the height of an item’s flash file.

  • $FlashURL — Contains the URL of an item’s flash file.

  • $FlashWidth — Contains the width of an item’s flash file.

  • $FormCloseOrder — Contains an item’s closing HTML form.

  • $FormOpenOrder — Contains an item’s opening HTML form.

  • $Free[1] …​$Free[20] — Contains the item free text fields.

  • $Height — Contains an item’s height.

  • $ID — Contains the item ID.

  • $ISBN — Contains the item’s International Standard Book Number (ISBN).

  • $Image[1] …​$Image[25] — HTML image tag of the images with the highest resolution.

  • $ImageAlt[1] …​$ImageAlt[25] — Contains the item image’s alternative text.

  • $ImageAttributeList — Contains an item’s attribute values as images. The images are linked to the attribute values in the item’s Images tab.

  • $ImageName[1] …​$ImageName[25] — Contains the item image’s name.

  • $ImageURL[1] …​$ImageURL[25] — URL of the images with the highest resolution.

  • $ItemAge — Contains an item’s age in days, starting from the date it was created in plentymarkets.

  • $ItemShipping[1] …​$ItemShipping[2] — Contains the item’s shipping costs.

  • $Length — Contains an item’s length.

  • $LimitOrderByStock — Contains the value for limiting the item to the stock; 0 = No limitation, 1 = Limited to net stock, 2 = Do not administer stock for this item.

  • $Lot — Contains the content of an item’s sales unit.

  • $MiddleSizeImage[1] …​$MiddleSizeImage[25] — HTML image tag of the images with medium resolution.

  • $MiddleSizeImageURL[1] …​$MiddleSizeImageURL[25] — URL of the images with medium resolution.

  • $Model — Model

  • $Name[1] …​$Name[3] — Contains the item name.

  • $Name4URL — Contains the URL-conform item name.

  • $Number — Contains the item number.

  • $OrderQuantityInterval

  • $OrderQuantityMax — Contains the item’s maximum order quantity.

  • $OrderQuantityMin — Contains the item’s minimum order quantity.

  • $PackagingUnit — Contains an item’s packaging unit.

  • $Position

  • $PreviewImage[1] …​$PreviewImage[25] — Returns the current item’s preview image.

  • $PreviewImageURL[1] …​$PreviewImageURL[25] — Returns the URL of the current item’s preview image.

  • $Price — Contains an item’s price.

  • $PriceCount — Contains the number of an item’s price sets.

  • $PriceDecimalSeparatorDot — Contains an item’s price; decimal separator is a dot.

  • $PriceDynamic — Contains the price of an item or of a variation including surcharges etc. When using this variable, the item price is automatically adjusted based on the variation selected.

  • $PriceID — Contains the ID of the item’s price set.

  • $PriceRadioButton — All price sets are displayed and selected using radio buttons.

  • $PriceSelect — Selection of all price sets as HTML select.

  • $Producer — Contains the name of the item manufacturer.

  • $ProducerAddressCity

  • $ProducerAddressCountryID

  • $ProducerAddressCountryName

  • $ProducerAddressHouseNo

  • $ProducerAddressStreet

  • $ProducerAddressZip

  • $ProducerEmail

  • $ProducerExternalName

  • $ProducerFax

  • $ProducerLogo — Contains the manufacturer logo.

  • $ProducerPhone

  • $ProducerURL — Contains the URL of the manufacturer. The URL is saved in the manufacturer data set.

  • $RRP — Contains the item’s recommended retail price.

  • $RRPDecimalSeparatorDot — Contains the recommended retail price; decimal separator is a dot.

  • $Rating — Contains the feedback.

  • $RatingCount — Contains the number of feedbacks for an item.

  • $RatingImage — Contains the average feedback.

  • $RatingMax

  • $RebateAvailable — Contains a query that checks whether a discounted price exists for an item that the customer is eligible for.

  • $ReleaseDate — Contains the item’s release date.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $Saving — Contains the discount amount.

  • $SavingDecimalSeparatorDot — Contains the discount amount; decimal separator is a dot.

  • $SavingDynamic

  • $SavingDynamicDecimalSeparatorDot

  • $SavingDynamicPercent

  • $SavingPercent — Contains the discount rate in percent.

  • $SecondPreviewImage[1] …​$SecondPreviewImage[25] — Returns the current item’s second preview image.

  • $SecondPreviewImageURL[1] …​$SecondPreviewImageURL[25] — Returns the URL of the current item’s second preview image.

  • $ShortName — Contains a shorter version of the item name. The item name is truncated after a specific number of characters.

  • $Size — Contains the information in Unit 1 and Unit 2 of an item’s Base tab.

  • $StockList — Contains an item’s physical stock.

  • $TechnicalData — Contains the item’s technical data.

  • $UnitString/$UnitString[1] …​$UnitString[2] — Contains the item unit.

  • $VAT — Contains the item’s VAT in percent.

  • $VATHint — Contains the VAT note, e.g. "incl. statutory VAT".

  • $VariationID — Contains the variation’s ID.

  • $VolumePrice[1] …​$VolumePrice[10] — Contains the price for an item’s minimum order quantity.

  • $VolumePriceStartingQuantity[1] …​$VolumePriceStartingQuantity[10] — Contains the minimum order quantity for a discount to be applied to an item.

  • $Volumen — Contains an item’s volume.

  • $Weight — Contains an item’s weight.

  • $WeightNet — Contains an item’s net weight.

  • $Width — Contains an item’s width.

5.4.8. Container_ItemViewAdvancedOrderItemsList3

Short description

Returns the template ItemViewAdvancedOrderItemsList3. This template is used to display a list of preordered items.

Description of this function
Container_ItemViewAdvancedOrderItemsList3(
int $ItemViewAdvancedOrderItemsList3_EachRow  ,
int $ItemViewAdvancedOrderItemsList3_Limit  ,
int $ItemViewAdvancedOrderItemsList3_OnlyOfCurrentCategory
) : string
Template ItemViewAdvancedOrderItemsList3
Variables

These variables are available in this container.

  • $Subcategoryselect — Contains a drop-down list of the subcategories of the next level.

ItemViewAdvancedOrderItemsList3Item
Functions

These functions are available in this container.

ButtonAddBasket1Small( string $_buttonValue  ) : string
ButtonAddBasketOverlay( string $_buttonValue  ) : string
GetBarcode( string $_barcodeName  ) : string
GetDocumentLinks( string '$_fileExtension'  ) :
GetItemViewStockList( int $ID  ) :
Link_CurrentCategory() : string
Variables

These variables are available in this container.

  • $ASIN — Contains an item’s first Amazon Standard Ident Number (ASIN).

  • $ActionId — Contains the online store special’s ID.

  • $AttributeExist — Contains a query that checks if an item has attributes.

  • $AttributeMatrix — Contains all variations of an item. These are displayed in a table in which customers can also enter the order quantity. Insert the variable in the section between FormOpenOrder and FormCloseOrder for the entered order quantity to be placed in the shopping cart. We recommend that you use the variable for a small number of attributes and attribute values only.

  • $AttributeSelect — Contains one drop-down list per attribute that contains an item’s attribute values. The attribute name is displayed above the drop-down list. The attribute values can be selected in a drop-down list.

  • $AttributeSelectWithoutAttributeName — Contains one drop-down list per attribute that contains the item’s attribute values.

  • $AvailabilityIcon — Contains the availability icon for the item availability. An icon is saved in the Setup » Item » Availability menu.

  • $AvailabilityId — Contains the ID of the item availability (1-10).

  • $AvailabilityString — Contains the name of the item availability. The names are saved in the Setup » Item » Availability menu.

  • $BasePrice — Contains an item’s unit price.

  • $BasePriceLot — Contains the price of an item’s sales unit.

  • $BasePriceUnit — Contains the unit for the unit price.

  • $CategoryId[Level1] …​$CategoryId[Level6] — Contains the ID of the item’s default category.

  • $CategoryName[Level1] …​$CategoryName[Level6] — Contains the name of the category.

  • $Condition — Contains the item condition.

  • $CreationDate — Contains an item’s creation date.

  • $DefaultShippingCost

  • $Description — Contains the item text.

  • $DescriptionShort — Contains the item preview text.

  • $EAN — Contains an item’s EAN 1.

  • $ExpirationDate — Contains an item’s expiration date ("available until").

  • $FSK — Contains an item’s age rating.

  • $FlashHeight — Contains the height of an item’s flash file.

  • $FlashURL — Contains the URL of an item’s flash file.

  • $FlashWidth — Contains the width of an item’s flash file.

  • $FormCloseOrder — Contains an item’s closing HTML form.

  • $FormOpenOrder — Contains an item’s opening HTML form.

  • $Free[1] …​$Free[20] — Contains the item free text fields.

  • $Height — Contains an item’s height.

  • $ID — Contains the item ID.

  • $ISBN — Contains the item’s International Standard Book Number (ISBN).

  • $Image[1] …​$Image[25] — HTML image tag of the images with the highest resolution.

  • $ImageAlt[1] …​$ImageAlt[25] — Contains the item image’s alternative text.

  • $ImageAttributeList — Contains an item’s attribute values as images. The images are linked to the attribute values in the item’s Images tab.

  • $ImageName[1] …​$ImageName[25] — Contains the item image’s name.

  • $ImageURL[1] …​$ImageURL[25] — URL of the images with the highest resolution.

  • $ItemAge — Contains an item’s age in days, starting from the date it was created in plentymarkets.

  • $ItemShipping[1] …​$ItemShipping[2] — Contains the item’s shipping costs.

  • $Length — Contains an item’s length.

  • $LimitOrderByStock — Contains the value for limiting the item to the stock; 0 = No limitation, 1 = Limited to net stock, 2 = Do not administer stock for this item.

  • $Lot — Contains the content of an item’s sales unit.

  • $MiddleSizeImage[1] …​$MiddleSizeImage[25] — HTML image tag of the images with medium resolution.

  • $MiddleSizeImageURL[1] …​$MiddleSizeImageURL[25] — URL of the images with medium resolution.

  • $Model — Model

  • $Name[1] …​$Name[3] — Contains the item name.

  • $Name4URL — Contains the URL-conform item name.

  • $Number — Contains the item number.

  • $OrderQuantityInterval

  • $OrderQuantityMax — Contains the item’s maximum order quantity.

  • $OrderQuantityMin — Contains the item’s minimum order quantity.

  • $PackagingUnit — Contains an item’s packaging unit.

  • $Position

  • $PreviewImage[1] …​$PreviewImage[25] — Returns the current item’s preview image.

  • $PreviewImageURL[1] …​$PreviewImageURL[25] — Returns the URL of the current item’s preview image.

  • $Price — Contains an item’s price.

  • $PriceCount — Contains the number of an item’s price sets.

  • $PriceDecimalSeparatorDot — Contains an item’s price; decimal separator is a dot.

  • $PriceDynamic — Contains the price of an item or of a variation including surcharges etc. When using this variable, the item price is automatically adjusted based on the variation selected.

  • $PriceID — Contains the ID of the item’s price set.

  • $PriceRadioButton — All price sets are displayed and selected using radio buttons.

  • $PriceSelect — Selection of all price sets as HTML select.

  • $Producer — Contains the name of the item manufacturer.

  • $ProducerAddressCity

  • $ProducerAddressCountryID

  • $ProducerAddressCountryName

  • $ProducerAddressHouseNo

  • $ProducerAddressStreet

  • $ProducerAddressZip

  • $ProducerEmail

  • $ProducerExternalName

  • $ProducerFax

  • $ProducerLogo — Contains the manufacturer logo.

  • $ProducerPhone

  • $ProducerURL — Contains the URL of the manufacturer. The URL is saved in the manufacturer data set.

  • $RRP — Contains the item’s recommended retail price.

  • $RRPDecimalSeparatorDot — Contains the recommended retail price; decimal separator is a dot.

  • $Rating — Contains the feedback.

  • $RatingCount — Contains the number of feedbacks for an item.

  • $RatingImage — Contains the average feedback.

  • $RatingMax

  • $RebateAvailable — Contains a query that checks whether a discounted price exists for an item that the customer is eligible for.

  • $ReleaseDate — Contains the item’s release date.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $Saving — Contains the discount amount.

  • $SavingDecimalSeparatorDot — Contains the discount amount; decimal separator is a dot.

  • $SavingDynamic

  • $SavingDynamicDecimalSeparatorDot

  • $SavingDynamicPercent

  • $SavingPercent — Contains the discount rate in percent.

  • $SecondPreviewImage[1] …​$SecondPreviewImage[25] — Returns the current item’s second preview image.

  • $SecondPreviewImageURL[1] …​$SecondPreviewImageURL[25] — Returns the URL of the current item’s second preview image.

  • $ShortName — Contains a shorter version of the item name. The item name is truncated after a specific number of characters.

  • $Size — Contains the information in Unit 1 and Unit 2 of an item’s Base tab.

  • $StockList — Contains an item’s physical stock.

  • $TechnicalData — Contains the item’s technical data.

  • $UnitString/$UnitString[1] …​$UnitString[2] — Contains the item unit.

  • $VAT — Contains the item’s VAT in percent.

  • $VATHint — Contains the VAT note, e.g. "incl. statutory VAT".

  • $VariationID — Contains the variation’s ID.

  • $VolumePrice[1] …​$VolumePrice[10] — Contains the price for an item’s minimum order quantity.

  • $VolumePriceStartingQuantity[1] …​$VolumePriceStartingQuantity[10] — Contains the minimum order quantity for a discount to be applied to an item.

  • $Volumen — Contains an item’s volume.

  • $Weight — Contains an item’s weight.

  • $WeightNet — Contains an item’s net weight.

  • $Width — Contains an item’s width.

5.4.9. Container_ItemViewAdvancedOrderItemsMultiPagesList

Short description

Returns the template ItemViewAdvancedOrderItemsMultiPagesList. This template is used to display a multi-page list of preordered items.

Description of this function
Container_ItemViewAdvancedOrderItemsMultiPagesList(
int $ItemViewAdvancedOrderItemsMultiPagesList_EachRow  ,
int $ItemViewAdvancedOrderItemsMultiPagesList_Limit  ,
int $ItemViewAdvancedOrderItemsMultiPagesList_OnlyOfCurrentCategory
) : string
Template ItemViewAdvancedOrderItemsMultiPagesList
Functions

These functions are available in this container.

BrowseNextButton( string $ItemViewAdvancedOrderItemsMultiPagesList_BrowseNextButtonName  ) : string
BrowsePreviousButton( string $ItemViewAdvancedOrderItemsMultiPagesList_BrowsePreviousButtonName  ) : string
ItemSorting(
string "select"  ,
string "ItemSortingSelectClass"  ,
array [0, 1, 2, 7, 3, 4, 5, 6, 8, 13, 9]  ,
array ["Top Seller", "Artikelposition aufsteigend", "Name A-Z", "Name Z-A", "Hersteller", "Preis aufsteigend", "Preis absteigend", "Älteste Produkte", "Neuste Produkte", "Erscheinungsdatum aufsteigend", "Erscheinungsdatum absteigend"]
) : string
Variables

These variables are available in this container.

  • $PageCount — Contains the number of pages returned.

  • $PageLinks — Contains the pagination.

  • $ProducerSelection — Contains check boxes to select a manufacturer. One manufacturer can be selected.

  • $ResultCount — Contains the number of the list elements returned.

  • $Subcategoryselect — Contains a drop-down list of the subcategories of the next level.

ItemViewAdvancedOrderItemsMultiPagesListItem
Functions

These functions are available in this container.

ButtonAddBasket1Small( string $_buttonValue  ) : string
ButtonAddBasketOverlay( string $_buttonValue  ) : string
GetBarcode( string $_barcodeName  ) : string
GetDocumentLinks( string '$_fileExtension'  ) :
GetItemViewStockList( int $ID  ) :
Link_CurrentCategory() : string
Variables

These variables are available in this container.

  • $ASIN — Contains an item’s first Amazon Standard Ident Number (ASIN).

  • $ActionId — Contains the online store special’s ID.

  • $AttributeExist — Contains a query that checks if an item has attributes.

  • $AttributeMatrix — Contains all variations of an item. These are displayed in a table in which customers can also enter the order quantity. Insert the variable in the section between FormOpenOrder and FormCloseOrder for the entered order quantity to be placed in the shopping cart. We recommend that you use the variable for a small number of attributes and attribute values only.

  • $AttributeSelect — Contains one drop-down list per attribute that contains an item’s attribute values. The attribute name is displayed above the drop-down list. The attribute values can be selected in a drop-down list.

  • $AttributeSelectWithoutAttributeName — Contains one drop-down list per attribute that contains the item’s attribute values.

  • $AvailabilityIcon — Contains the availability icon for the item availability. An icon is saved in the Setup » Item » Availability menu.

  • $AvailabilityId — Contains the ID of the item availability (1-10).

  • $AvailabilityString — Contains the name of the item availability. The names are saved in the Setup » Item » Availability menu.

  • $BasePrice — Contains an item’s unit price.

  • $BasePriceLot — Contains the price of an item’s sales unit.

  • $BasePriceUnit — Contains the unit for the unit price.

  • $CategoryId[Level1] …​$CategoryId[Level6] — Contains the ID of the item’s default category.

  • $CategoryName[Level1] …​$CategoryName[Level6] — Contains the name of the category.

  • $Condition — Contains the item condition.

  • $CreationDate — Contains an item’s creation date.

  • $DefaultShippingCost

  • $Description — Contains the item text.

  • $DescriptionShort — Contains the item preview text.

  • $EAN — Contains an item’s EAN 1.

  • $ExpirationDate — Contains an item’s expiration date ("available until").

  • $FSK — Contains an item’s age rating.

  • $FlashHeight — Contains the height of an item’s flash file.

  • $FlashURL — Contains the URL of an item’s flash file.

  • $FlashWidth — Contains the width of an item’s flash file.

  • $FormCloseOrder — Contains an item’s closing HTML form.

  • $FormOpenOrder — Contains an item’s opening HTML form.

  • $Free[1] …​$Free[20] — Contains the item free text fields.

  • $Height — Contains an item’s height.

  • $ID — Contains the item ID.

  • $ISBN — Contains the item’s International Standard Book Number (ISBN).

  • $Image[1] …​$Image[25] — HTML image tag of the images with the highest resolution.

  • $ImageAlt[1] …​$ImageAlt[25] — Contains the item image’s alternative text.

  • $ImageAttributeList — Contains an item’s attribute values as images. The images are linked to the attribute values in the item’s Images tab.

  • $ImageName[1] …​$ImageName[25] — Contains the item image’s name.

  • $ImageURL[1] …​$ImageURL[25] — URL of the images with the highest resolution.

  • $ItemAge — Contains an item’s age in days, starting from the date it was created in plentymarkets.

  • $ItemShipping[1] …​$ItemShipping[2] — Contains the item’s shipping costs.

  • $Length — Contains an item’s length.

  • $LimitOrderByStock — Contains the value for limiting the item to the stock; 0 = No limitation, 1 = Limited to net stock, 2 = Do not administer stock for this item.

  • $Lot — Contains the content of an item’s sales unit.

  • $MiddleSizeImage[1] …​$MiddleSizeImage[25] — HTML image tag of the images with medium resolution.

  • $MiddleSizeImageURL[1] …​$MiddleSizeImageURL[25] — URL of the images with medium resolution.

  • $Model — Model

  • $Name[1] …​$Name[3] — Contains the item name.

  • $Name4URL — Contains the URL-conform item name.

  • $Number — Contains the item number.

  • $OrderQuantityInterval

  • $OrderQuantityMax — Contains the item’s maximum order quantity.

  • $OrderQuantityMin — Contains the item’s minimum order quantity.

  • $PackagingUnit — Contains an item’s packaging unit.

  • $Position

  • $PreviewImage[1] …​$PreviewImage[25] — Returns the current item’s preview image.

  • $PreviewImageURL[1] …​$PreviewImageURL[25] — Returns the URL of the current item’s preview image.

  • $Price — Contains an item’s price.

  • $PriceCount — Contains the number of an item’s price sets.

  • $PriceDecimalSeparatorDot — Contains an item’s price; decimal separator is a dot.

  • $PriceDynamic — Contains the price of an item or of a variation including surcharges etc. When using this variable, the item price is automatically adjusted based on the variation selected.

  • $PriceID — Contains the ID of the item’s price set.

  • $PriceRadioButton — All price sets are displayed and selected using radio buttons.

  • $PriceSelect — Selection of all price sets as HTML select.

  • $Producer — Contains the name of the item manufacturer.

  • $ProducerAddressCity

  • $ProducerAddressCountryID

  • $ProducerAddressCountryName

  • $ProducerAddressHouseNo

  • $ProducerAddressStreet

  • $ProducerAddressZip

  • $ProducerEmail

  • $ProducerExternalName

  • $ProducerFax

  • $ProducerLogo — Contains the manufacturer logo.

  • $ProducerPhone

  • $ProducerURL — Contains the URL of the manufacturer. The URL is saved in the manufacturer data set.

  • $RRP — Contains the item’s recommended retail price.

  • $RRPDecimalSeparatorDot — Contains the recommended retail price; decimal separator is a dot.

  • $Rating — Contains the feedback.

  • $RatingCount — Contains the number of feedbacks for an item.

  • $RatingImage — Contains the average feedback.

  • $RatingMax

  • $RebateAvailable — Contains a query that checks whether a discounted price exists for an item that the customer is eligible for.

  • $ReleaseDate — Contains the item’s release date.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $Saving — Contains the discount amount.

  • $SavingDecimalSeparatorDot — Contains the discount amount; decimal separator is a dot.

  • $SavingDynamic

  • $SavingDynamicDecimalSeparatorDot

  • $SavingDynamicPercent

  • $SavingPercent — Contains the discount rate in percent.

  • $SecondPreviewImage[1] …​$SecondPreviewImage[25] — Returns the current item’s second preview image.

  • $SecondPreviewImageURL[1] …​$SecondPreviewImageURL[25] — Returns the URL of the current item’s second preview image.

  • $ShortName — Contains a shorter version of the item name. The item name is truncated after a specific number of characters.

  • $Size — Contains the information in Unit 1 and Unit 2 of an item’s Base tab.

  • $StockList — Contains an item’s physical stock.

  • $TechnicalData — Contains the item’s technical data.

  • $UnitString/$UnitString[1] …​$UnitString[2] — Contains the item unit.

  • $VAT — Contains the item’s VAT in percent.

  • $VATHint — Contains the VAT note, e.g. "incl. statutory VAT".

  • $VariationID — Contains the variation’s ID.

  • $VolumePrice[1] …​$VolumePrice[10] — Contains the price for an item’s minimum order quantity.

  • $VolumePriceStartingQuantity[1] …​$VolumePriceStartingQuantity[10] — Contains the minimum order quantity for a discount to be applied to an item.

  • $Volumen — Contains an item’s volume.

  • $Weight — Contains an item’s weight.

  • $WeightNet — Contains an item’s net weight.

  • $Width — Contains an item’s width.

5.4.10. Container_ItemViewBasketItemsList

Short description

Returns the template ItemViewBasketItemsList. This template is used to display a list of shopping cart items.

Description of this function
Container_ItemViewBasketItemsList() : string
Template ItemViewBasketItemsList
ItemViewBasketItemsListItem
Variables

These variables are available in this container.

  • $Attribute

  • $BasePrice — Contains an item’s unit price.

  • $BasePriceLot — Contains the price of an item’s sales unit.

  • $BasePriceUnit — Contains the unit for the unit price.

  • $CategoryId[Level1] …​$CategoryId[Level6] — Contains the ID of the item’s default category.

  • $CategoryName[Level1] …​$CategoryName[Level6] — Contains the name of the category.

  • $EAN — Contains an item’s EAN 1.

  • $Free[1] …​$Free[20] — Contains the item free text fields.

  • $ID — Contains the item ID.

  • $ISBN — Contains the item’s International Standard Book Number (ISBN).

  • $Image/$Image[1] …​$Image[1] — HTML image tag of the images with the highest resolution.

  • $ImageAlt/$ImageAlt[1] …​$ImageAlt[1] — Contains the item image’s alternative text.

  • $ImageName/$ImageName[1] …​$ImageName[1] — Contains the item image’s name.

  • $ImageURL/$ImageURL[1] …​$ImageURL[1] — URL of the images with the highest resolution.

  • $ItemBranchId — Contains the ID of the item’s default category.

  • $Lot — Contains the content of an item’s sales unit.

  • $MiddleSizeImage/$MiddleSizeImage[1] …​$MiddleSizeImage[1] — HTML image tag of the images with medium resolution.

  • $MiddleSizeImageURL/$MiddleSizeImageURL[1] …​$MiddleSizeImageURL[1] — URL of the images with medium resolution.

  • $Name[1] …​$Name[3] — Contains the item name.

  • $Name4URL — Contains the URL-conform item name.

  • $Number — Contains the item number.

  • $PreviewImage/$PreviewImage[1] …​$PreviewImage[1] — Returns the current item’s preview image.

  • $PreviewImageURL/$PreviewImageURL[1] …​$PreviewImageURL[1] — Returns the URL of the current item’s preview image.

  • $Price — Contains an item’s price.

  • $PriceDecimalSeparatorDot — Contains an item’s price; decimal separator is a dot.

  • $Quantity — Contains the number of items in the shopping cart.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $SecondPreviewImage/$SecondPreviewImage[1] …​$SecondPreviewImage[1] — Returns the current item’s second preview image.

  • $SecondPreviewImageURL/$SecondPreviewImageURL[1] …​$SecondPreviewImageURL[1] — Returns the URL of the current item’s second preview image.

  • $ShortName — Contains a shorter version of the item name. The item name is truncated after a specific number of characters.

  • $Unit

5.4.11. Container_ItemViewBasketItemsList2

Short description

Returns the template ItemViewBasketItemsList2. This template is used to display a list of shopping cart items.

Description of this function
Container_ItemViewBasketItemsList2() : string
Template ItemViewBasketItemsList2
ItemViewBasketItemsList2Item
Variables

These variables are available in this container.

  • $Attribute

  • $BasePrice — Contains an item’s unit price.

  • $BasePriceLot — Contains the price of an item’s sales unit.

  • $BasePriceUnit — Contains the unit for the unit price.

  • $CategoryId[Level1] …​$CategoryId[Level6] — Contains the ID of the item’s default category.

  • $CategoryName[Level1] …​$CategoryName[Level6] — Contains the name of the category.

  • $EAN — Contains an item’s EAN 1.

  • $Free[1] …​$Free[20] — Contains the item free text fields.

  • $ID — Contains the item ID.

  • $ISBN — Contains the item’s International Standard Book Number (ISBN).

  • $Image/$Image[1] …​$Image[1] — HTML image tag of the images with the highest resolution.

  • $ImageURL/$ImageURL[1] …​$ImageURL[1] — URL of the images with the highest resolution.

  • $ItemBranchId — Contains the ID of the item’s default category.

  • $Lot — Contains the content of an item’s sales unit.

  • $MiddleSizeImage/$MiddleSizeImage[1] …​$MiddleSizeImage[1] — HTML image tag of the images with medium resolution.

  • $MiddleSizeImageURL/$MiddleSizeImageURL[1] …​$MiddleSizeImageURL[1] — URL of the images with medium resolution.

  • $Name[1] …​$Name[3] — Contains the item name.

  • $Name4URL — Contains the URL-conform item name.

  • $Number — Contains the item number.

  • $PreviewImage/$PreviewImage[1] …​$PreviewImage[1] — Returns the current item’s preview image.

  • $PreviewImageURL/$PreviewImageURL[1] …​$PreviewImageURL[1] — Returns the URL of the current item’s preview image.

  • $Price — Contains an item’s price.

  • $PriceDecimalSeparatorDot — Contains an item’s price; decimal separator is a dot.

  • $Quantity — Contains the number of items in the shopping cart.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $SecondPreviewImage/$SecondPreviewImage[1] …​$SecondPreviewImage[1] — Returns the current item’s second preview image.

  • $SecondPreviewImageURL/$SecondPreviewImageURL[1] …​$SecondPreviewImageURL[1] — Returns the URL of the current item’s second preview image.

  • $ShortName — Contains a shorter version of the item name. The item name is truncated after a specific number of characters.

  • $Unit

5.4.12. Container_ItemViewBasketPreviewList

Short description

Returns the template ItemViewBasketPreviewList. This template is used to display a preview of shopping cart items.

Description of this function
Container_ItemViewBasketPreviewList() : string
Template ItemViewBasketPreviewList
ItemViewBasketPreviewListItem
Functions

These functions are available in this container.

ButtonDeleteBasketItem( string $_buttonValue  )
Link_CurrentCategory() : string
Variables

These variables are available in this container.

  • $Attribute

  • $BasePrice — Contains an item’s unit price.

  • $BasePriceLot — Contains the price of an item’s sales unit.

  • $BasePriceUnit — Contains the unit for the unit price.

  • $BasketRowId

  • $CategoryId[Level1] …​$CategoryId[Level6] — Contains the ID of the item’s default category.

  • $CategoryName[Level1] …​$CategoryName[Level6] — Contains the name of the category.

  • $EAN — Contains an item’s EAN 1.

  • $Free[1] …​$Free[20] — Contains the item free text fields.

  • $ID — Contains the item ID.

  • $ISBN — Contains the item’s International Standard Book Number (ISBN).

  • $Image/$Image[1] …​$Image[1] — HTML image tag of the images with the highest resolution.

  • $ImageAlt/$ImageAlt[1] …​$ImageAlt[1] — Contains the item image’s alternative text.

  • $ImageName/$ImageName[1] …​$ImageName[1] — Contains the item image’s name.

  • $ImageURL/$ImageURL[1] …​$ImageURL[1] — URL of the images with the highest resolution.

  • $ItemBranchId — Contains the ID of the item’s default category.

  • $Lot — Contains the content of an item’s sales unit.

  • $MiddleSizeImage/$MiddleSizeImage[1] …​$MiddleSizeImage[1] — HTML image tag of the images with medium resolution.

  • $MiddleSizeImageURL/$MiddleSizeImageURL[1] …​$MiddleSizeImageURL[1] — URL of the images with medium resolution.

  • $Name[1] …​$Name[3] — Contains the item name.

  • $Name4URL — Contains the URL-conform item name.

  • $Number — Contains the item number.

  • $PreviewImage/$PreviewImage[1] …​$PreviewImage[1] — Returns the current item’s preview image.

  • $PreviewImageURL/$PreviewImageURL[1] …​$PreviewImageURL[1] — Returns the URL of the current item’s preview image.

  • $Price — Contains an item’s price.

  • $PriceDecimalSeparatorDot — Contains an item’s price; decimal separator is a dot.

  • $Quantity — Contains the number of items in the shopping cart.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $SecondPreviewImage/$SecondPreviewImage[1] …​$SecondPreviewImage[1] — Returns the current item’s second preview image.

  • $SecondPreviewImageURL/$SecondPreviewImageURL[1] …​$SecondPreviewImageURL[1] — Returns the URL of the current item’s second preview image.

  • $ShortName — Contains a shorter version of the item name. The item name is truncated after a specific number of characters.

  • $Unit

Examples

<div class="basketItems overlay">
    {% Container_ItemViewBasketPreviewList() %}
</div>

5.4.13. Container_ItemViewCategoriesList

Short description

Returns the template ItemViewCategoriesList. This template is used to display items of a category.

Description of this function
Container_ItemViewCategoriesList(
int $ItemViewCategoriesList_EachRow  ,
int $ItemViewCategoriesList_ItemsPerPage  ,
int $ItemViewCategoriesList_GroupByVariation  ,
int $ItemViewCategoriesList_CatLevel1DefaultItemSorting  ,
int $ItemViewCategoriesList_CatLevel2DefaultItemSorting
) : string
Template ItemViewCategoriesList
Functions

These functions are available in this container.

BrowseNextButton( string $ItemViewCategoriesList_BrowseNextButtonName  ) : string
BrowsePreviousButton( string $ItemViewCategoriesList_BrowsePreviousButtonName  ) : string
CategoriesListItemsPerPageSelect( array [5,20,50,100]  , string "select"  , string "ItemsPerPageSelectClass"  ) : string
ItemSorting(
string "select"  ,
string "ItemSortingSelectClass"  ,
array [0, 1, 2, 7, 3, 4, 5, 6, 8, 13, 9]  ,
array ["Top Seller", "Artikelposition aufsteigend", "Name A-Z", "Name Z-A", "Hersteller", "Preis aufsteigend", "Preis absteigend", "Älteste Produkte", "Neuste Produkte", "Erscheinungsdatum aufsteigend", "Erscheinungsdatum absteigend"]
) : string
Link_ChangeCategoryListTemplate( int ) : string
Variables

These variables are available in this container.

  • $PageCount — Contains the number of pages returned.

  • $PageLinks — Contains the pagination.

  • $ProducerSelection — Contains check boxes to select a manufacturer. One manufacturer can be selected.

  • $ResultCount — Contains the number of the list elements returned.

  • $Subcategoryselect — Contains a drop-down list of the subcategories of the next level.

ItemViewCategoriesListItem
Functions

These functions are available in this container.

ButtonAddBasket1Small( string $_buttonValue  ) : string
ButtonAddBasketOverlay( string $_buttonValue  ) : string
GetBarcode( string $_barcodeName  ) : string
GetDocumentLinks( string '$_fileExtension'  ) :
GetItemViewStockList( int $ID  ) :
Link_CurrentCategory() : string
Variables

These variables are available in this container.

  • $ASIN — Contains an item’s first Amazon Standard Ident Number (ASIN).

  • $ActionId — Contains the online store special’s ID.

  • $AttributeExist — Contains a query that checks if an item has attributes.

  • $AttributeMatrix — Contains all variations of an item. These are displayed in a table in which customers can also enter the order quantity. Insert the variable in the section between FormOpenOrder and FormCloseOrder for the entered order quantity to be placed in the shopping cart. We recommend that you use the variable for a small number of attributes and attribute values only.

  • $AttributeSelect — Contains one drop-down list per attribute that contains an item’s attribute values. The attribute name is displayed above the drop-down list. The attribute values can be selected in a drop-down list.

  • $AttributeSelectWithoutAttributeName — Contains one drop-down list per attribute that contains the item’s attribute values.

  • $AvailabilityIcon — Contains the availability icon for the item availability. An icon is saved in the Setup » Item » Availability menu.

  • $AvailabilityId — Contains the ID of the item availability (1-10).

  • $AvailabilityString — Contains the name of the item availability. The names are saved in the Setup » Item » Availability menu.

  • $BasePrice — Contains an item’s unit price.

  • $BasePriceLot — Contains the price of an item’s sales unit.

  • $BasePriceUnit — Contains the unit for the unit price.

  • $CategoryId[Level1] …​$CategoryId[Level6] — Contains the ID of the item’s default category.

  • $CategoryName[Level1] …​$CategoryName[Level6] — Contains the name of the category.

  • $Condition — Contains the item condition.

  • $CreationDate — Contains an item’s creation date.

  • $DefaultShippingCost

  • $Description — Contains the item text.

  • $DescriptionShort — Contains the item preview text.

  • $EAN — Contains an item’s EAN 1.

  • $ExpirationDate — Contains an item’s expiration date ("available until").

  • $FSK — Contains an item’s age rating.

  • $FlashHeight — Contains the height of an item’s flash file.

  • $FlashURL — Contains the URL of an item’s flash file.

  • $FlashWidth — Contains the width of an item’s flash file.

  • $FormCloseOrder — Contains an item’s closing HTML form.

  • $FormOpenOrder — Contains an item’s opening HTML form.

  • $Free[1] …​$Free[20] — Contains the item free text fields.

  • $Height — Contains an item’s height.

  • $ID — Contains the item ID.

  • $ISBN — Contains the item’s International Standard Book Number (ISBN).

  • $Image[1] …​$Image[25] — HTML image tag of the images with the highest resolution.

  • $ImageAlt[1] …​$ImageAlt[25] — Contains the item image’s alternative text.

  • $ImageAttributeList — Contains an item’s attribute values as images. The images are linked to the attribute values in the item’s Images tab.

  • $ImageName[1] …​$ImageName[25] — Contains the item image’s name.

  • $ImageURL[1] …​$ImageURL[25] — URL of the images with the highest resolution.

  • $ItemAge — Contains an item’s age in days, starting from the date it was created in plentymarkets.

  • $ItemShipping[1] …​$ItemShipping[2] — Contains the item’s shipping costs.

  • $Length — Contains an item’s length.

  • $LimitOrderByStock — Contains the value for limiting the item to the stock; 0 = No limitation, 1 = Limited to net stock, 2 = Do not administer stock for this item.

  • $Lot — Contains the content of an item’s sales unit.

  • $MiddleSizeImage[1] …​$MiddleSizeImage[25] — HTML image tag of the images with medium resolution.

  • $MiddleSizeImageURL[1] …​$MiddleSizeImageURL[25] — URL of the images with medium resolution.

  • $Model — Model

  • $Name[1] …​$Name[3] — Contains the item name.

  • $Name4URL — Contains the URL-conform item name.

  • $Number — Contains the item number.

  • $OrderQuantityInterval

  • $OrderQuantityMax — Contains the item’s maximum order quantity.

  • $OrderQuantityMin — Contains the item’s minimum order quantity.

  • $PackagingUnit — Contains an item’s packaging unit.

  • $Position

  • $PreviewImage[1] …​$PreviewImage[25] — Returns the current item’s preview image.

  • $PreviewImageURL[1] …​$PreviewImageURL[25] — Returns the URL of the current item’s preview image.

  • $Price — Contains an item’s price.

  • $PriceCount — Contains the number of an item’s price sets.

  • $PriceDecimalSeparatorDot — Contains an item’s price; decimal separator is a dot.

  • $PriceDynamic — Contains the price of an item or of a variation including surcharges etc. When using this variable, the item price is automatically adjusted based on the variation selected.

  • $PriceID — Contains the ID of the item’s price set.

  • $PriceRadioButton — All price sets are displayed and selected using radio buttons.

  • $PriceSelect — Selection of all price sets as HTML select.

  • $Producer — Contains the name of the item manufacturer.

  • $ProducerAddressCity

  • $ProducerAddressCountryID

  • $ProducerAddressCountryName

  • $ProducerAddressHouseNo

  • $ProducerAddressStreet

  • $ProducerAddressZip

  • $ProducerEmail

  • $ProducerExternalName

  • $ProducerFax

  • $ProducerLogo — Contains the manufacturer logo.

  • $ProducerPhone

  • $ProducerURL — Contains the URL of the manufacturer. The URL is saved in the manufacturer data set.

  • $RRP — Contains the item’s recommended retail price.

  • $RRPDecimalSeparatorDot — Contains the recommended retail price; decimal separator is a dot.

  • $Rating — Contains the feedback.

  • $RatingCount — Contains the number of feedbacks for an item.

  • $RatingImage — Contains the average feedback.

  • $RatingMax

  • $RebateAvailable — Contains a query that checks whether a discounted price exists for an item that the customer is eligible for.

  • $RebatesMinimumPrice

  • $RebatesMinimumPriceQuantity

  • $ReleaseDate — Contains the item’s release date.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $Saving — Contains the discount amount.

  • $SavingDecimalSeparatorDot — Contains the discount amount; decimal separator is a dot.

  • $SavingDynamic

  • $SavingDynamicDecimalSeparatorDot

  • $SavingDynamicPercent

  • $SavingPercent — Contains the discount rate in percent.

  • $SecondPreviewImage[1] …​$SecondPreviewImage[25] — Returns the current item’s second preview image.

  • $SecondPreviewImageURL[1] …​$SecondPreviewImageURL[25] — Returns the URL of the current item’s second preview image.

  • $ShortName — Contains a shorter version of the item name. The item name is truncated after a specific number of characters.

  • $Size — Contains the information in Unit 1 and Unit 2 of an item’s Base tab.

  • $StockList — Contains an item’s physical stock.

  • $TechnicalData — Contains the item’s technical data.

  • $UnitString/$UnitString[1] …​$UnitString[2] — Contains the item unit.

  • $VAT — Contains the item’s VAT in percent.

  • $VATHint — Contains the VAT note, e.g. "incl. statutory VAT".

  • $VariationID — Contains the variation’s ID.

  • $VolumePrice[1] …​$VolumePrice[10] — Contains the price for an item’s minimum order quantity.

  • $VolumePriceStartingQuantity[1] …​$VolumePriceStartingQuantity[10] — Contains the minimum order quantity for a discount to be applied to an item.

  • $Volumen — Contains an item’s volume.

  • $Weight — Contains an item’s weight.

  • $WeightNet — Contains an item’s net weight.

  • $Width — Contains an item’s width.

Examples

<div class="basketItems overlay">
    {% Container_ItemViewBasketPreviewList() %}
</div>

5.4.14. Container_ItemViewCategoriesList2

Short description

Returns the template ItemViewCategoriesList2. This template is used to display items of a category.

Description of this function
Container_ItemViewCategoriesList2(
int $ItemViewCategoriesList2_EachRow  ,
int $ItemViewCategoriesList2_ItemsPerPage  ,
int $ItemViewCategoriesList2_GroupByVariation  ,
int $ItemViewCategoriesList2_CatLevel1DefaultItemSorting  ,
int $ItemViewCategoriesList2_CatLevel2DefaultItemSorting
) : string
Template ItemViewCategoriesList2
Functions

These functions are available in this container.

BrowseNextButton( string $ItemViewCategoriesList2_BrowseNextButtonName  ) : string
BrowsePreviousButton( string $ItemViewCategoriesList2_BrowsePreviousButtonName  ) : string
CategoriesListItemsPerPageSelect( array [5,20,50,100]  , string "select"  , string "ItemsPerPageSelectClass"  ) : string
ItemSorting(
string "select"  ,
string "ItemSortingSelectClass"  ,
array [0, 1, 2, 7, 3, 4, 5, 6, 8, 13, 9]  ,
array ["Top Seller", "Artikelposition aufsteigend", "Name A-Z", "Name Z-A", "Hersteller", "Preis aufsteigend", "Preis absteigend", "Älteste Produkte", "Neuste Produkte", "Erscheinungsdatum aufsteigend", "Erscheinungsdatum absteigend"]
) : string
Link_ChangeCategoryListTemplate( int ) : string
Variables

These variables are available in this container.

  • $PageCount — Contains the number of pages returned.

  • $PageLinks — Contains the pagination.

  • $ProducerSelection — Contains check boxes to select a manufacturer. One manufacturer can be selected.

  • $ResultCount — Contains the number of the list elements returned.

  • $Subcategoryselect — Contains a drop-down list of the subcategories of the next level.

ItemViewCategoriesList2Item
Functions

These functions are available in this container.

ButtonAddBasket1Small( string $_buttonValue  ) : string
ButtonAddBasketOverlay( string $_buttonValue  ) : string
GetBarcode( string $_barcodeName  ) : string
GetDocumentLinks( string '$_fileExtension'  ) :
GetItemViewStockList( int $ID  ) :
Link_CurrentCategory() : string
Variables

These variables are available in this container.

  • $ASIN — Contains an item’s first Amazon Standard Ident Number (ASIN).

  • $ActionId — Contains the online store special’s ID.

  • $AttributeExist — Contains a query that checks if an item has attributes.

  • $AttributeMatrix — Contains all variations of an item. These are displayed in a table in which customers can also enter the order quantity. Insert the variable in the section between FormOpenOrder and FormCloseOrder for the entered order quantity to be placed in the shopping cart. We recommend that you use the variable for a small number of attributes and attribute values only.

  • $AttributeSelect — Contains one drop-down list per attribute that contains an item’s attribute values. The attribute name is displayed above the drop-down list. The attribute values can be selected in a drop-down list.

  • $AttributeSelectWithoutAttributeName — Contains one drop-down list per attribute that contains the item’s attribute values.

  • $AvailabilityIcon — Contains the availability icon for the item availability. An icon is saved in the Setup » Item » Availability menu.

  • $AvailabilityId — Contains the ID of the item availability (1-10).

  • $AvailabilityString — Contains the name of the item availability. The names are saved in the Setup » Item » Availability menu.

  • $BasePrice — Contains an item’s unit price.

  • $BasePriceLot — Contains the price of an item’s sales unit.

  • $BasePriceUnit — Contains the unit for the unit price.

  • $CategoryId[Level1] …​$CategoryId[Level6] — Contains the ID of the item’s default category.

  • $CategoryName[Level1] …​$CategoryName[Level6] — Contains the name of the category.

  • $Condition — Contains the item condition.

  • $CreationDate — Contains an item’s creation date.

  • $DefaultShippingCost

  • $Description — Contains the item text.

  • $DescriptionShort — Contains the item preview text.

  • $EAN — Contains an item’s EAN 1.

  • $ExpirationDate — Contains an item’s expiration date ("available until").

  • $FSK — Contains an item’s age rating.

  • $FlashHeight — Contains the height of an item’s flash file.

  • $FlashURL — Contains the URL of an item’s flash file.

  • $FlashWidth — Contains the width of an item’s flash file.

  • $FormCloseOrder — Contains an item’s closing HTML form.

  • $FormOpenOrder — Contains an item’s opening HTML form.

  • $Free[1] …​$Free[20] — Contains the item free text fields.

  • $Height — Contains an item’s height.

  • $ID — Contains the item ID.

  • $ISBN — Contains the item’s International Standard Book Number (ISBN).

  • $Image[1] …​$Image[25] — HTML image tag of the images with the highest resolution.

  • $ImageAlt[1] …​$ImageAlt[25] — Contains the item image’s alternative text.

  • $ImageAttributeList — Contains an item’s attribute values as images. The images are linked to the attribute values in the item’s Images tab.

  • $ImageName[1] …​$ImageName[25] — Contains the item image’s name.

  • $ImageURL[1] …​$ImageURL[25] — URL of the images with the highest resolution.

  • $ItemAge — Contains an item’s age in days, starting from the date it was created in plentymarkets.

  • $ItemShipping[1] …​$ItemShipping[2] — Contains the item’s shipping costs.

  • $Length — Contains an item’s length.

  • $LimitOrderByStock — Contains the value for limiting the item to the stock; 0 = No limitation, 1 = Limited to net stock, 2 = Do not administer stock for this item.

  • $Lot — Contains the content of an item’s sales unit.

  • $MiddleSizeImage[1] …​$MiddleSizeImage[25] — HTML image tag of the images with medium resolution.

  • $MiddleSizeImageURL[1] …​$MiddleSizeImageURL[25] — URL of the images with medium resolution.

  • $Model — Model

  • $Name[1] …​$Name[3] — Contains the item name.

  • $Name4URL — Contains the URL-conform item name.

  • $Number — Contains the item number.

  • $OrderQuantityInterval

  • $OrderQuantityMax — Contains the item’s maximum order quantity.

  • $OrderQuantityMin — Contains the item’s minimum order quantity.

  • $PackagingUnit — Contains an item’s packaging unit.

  • $Position

  • $PreviewImage[1] …​$PreviewImage[25] — Returns the current item’s preview image.

  • $PreviewImageURL[1] …​$PreviewImageURL[25] — Returns the URL of the current item’s preview image.

  • $Price — Contains an item’s price.

  • $PriceCount — Contains the number of an item’s price sets.

  • $PriceDecimalSeparatorDot — Contains an item’s price; decimal separator is a dot.

  • $PriceDynamic — Contains the price of an item or of a variation including surcharges etc. When using this variable, the item price is automatically adjusted based on the variation selected.

  • $PriceID — Contains the ID of the item’s price set.

  • $PriceRadioButton — All price sets are displayed and selected using radio buttons.

  • $PriceSelect — Selection of all price sets as HTML select.

  • $Producer — Contains the name of the item manufacturer.

  • $ProducerAddressCity

  • $ProducerAddressCountryID

  • $ProducerAddressCountryName

  • $ProducerAddressHouseNo

  • $ProducerAddressStreet

  • $ProducerAddressZip

  • $ProducerEmail

  • $ProducerExternalName

  • $ProducerFax

  • $ProducerLogo — Contains the manufacturer logo.

  • $ProducerPhone

  • $ProducerURL — Contains the URL of the manufacturer. The URL is saved in the manufacturer data set.

  • $RRP — Contains the item’s recommended retail price.

  • $RRPDecimalSeparatorDot — Contains the recommended retail price; decimal separator is a dot.

  • $Rating — Contains the feedback.

  • $RatingCount — Contains the number of feedbacks for an item.

  • $RatingImage — Contains the average feedback.

  • $RatingMax

  • $RebateAvailable — Contains a query that checks whether a discounted price exists for an item that the customer is eligible for.

  • $RebatesMinimumPrice

  • $RebatesMinimumPriceQuantity

  • $ReleaseDate — Contains the item’s release date.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $Saving — Contains the discount amount.

  • $SavingDecimalSeparatorDot — Contains the discount amount; decimal separator is a dot.

  • $SavingDynamic

  • $SavingDynamicDecimalSeparatorDot

  • $SavingDynamicPercent

  • $SavingPercent — Contains the discount rate in percent.

  • $SecondPreviewImage[1] …​$SecondPreviewImage[25] — Returns the current item’s second preview image.

  • $SecondPreviewImageURL[1] …​$SecondPreviewImageURL[25] — Returns the URL of the current item’s second preview image.

  • $ShortName — Contains a shorter version of the item name. The item name is truncated after a specific number of characters.

  • $Size — Contains the information in Unit 1 and Unit 2 of an item’s Base tab.

  • $StockList — Contains an item’s physical stock.

  • $TechnicalData — Contains the item’s technical data.

  • $UnitString/$UnitString[1] …​$UnitString[2] — Contains the item unit.

  • $VAT — Contains the item’s VAT in percent.

  • $VATHint — Contains the VAT note, e.g. "incl. statutory VAT".

  • $VariationID — Contains the variation’s ID.

  • $VolumePrice[1] …​$VolumePrice[10] — Contains the price for an item’s minimum order quantity.

  • $VolumePriceStartingQuantity[1] …​$VolumePriceStartingQuantity[10] — Contains the minimum order quantity for a discount to be applied to an item.

  • $Volumen — Contains an item’s volume.

  • $Weight — Contains an item’s weight.

  • $WeightNet — Contains an item’s net weight.

  • $Width — Contains an item’s width.

Examples

<div class="basketItems overlay">
    {% Container_ItemViewBasketPreviewList() %}
</div>

5.4.15. Container_ItemViewCategoriesList3

Short description

Returns the template ItemViewCategoriesList3. This template is used to display items of a category.

Description of this function
Container_ItemViewCategoriesList3(
int $ItemViewCategoriesList3_EachRow  ,
int $ItemViewCategoriesList3_ItemsPerPage  ,
int $ItemViewCategoriesList3_GroupByVariation  ,
int $ItemViewCategoriesList3_CatLevel1DefaultItemSorting  ,
int $ItemViewCategoriesList3_CatLevel2DefaultItemSorting
) : string
Template ItemViewCategoriesList3
Functions

These functions are available in this container.

BrowseNextButton( string $ItemViewCategoriesList3_BrowseNextButtonName  ) : string
BrowsePreviousButton( string $ItemViewCategoriesList3_BrowsePreviousButtonName  ) : string
CategoriesListItemsPerPageSelect( array [5,20,50,100]  , string "select"  , string "ItemsPerPageSelectClass"  ) : string
ItemSorting(
string "select"  ,
string "ItemSortingSelectClass"  ,
array [0, 1, 2, 7, 3, 4, 5, 6, 8, 13, 9]  ,
array ["Top Seller", "Artikelposition aufsteigend", "Name A-Z", "Name Z-A", "Hersteller", "Preis aufsteigend", "Preis absteigend", "Älteste Produkte", "Neuste Produkte", "Erscheinungsdatum aufsteigend", "Erscheinungsdatum absteigend"]
) : string
Link_ChangeCategoryListTemplate( int ) : string
Variables

These variables are available in this container.

  • $PageCount — Contains the number of pages returned.

  • $PageLinks — Contains the pagination.

  • $ProducerSelection — Contains check boxes to select a manufacturer. One manufacturer can be selected.

  • $ResultCount — Contains the number of the list elements returned.

  • $Subcategoryselect — Contains a drop-down list of the subcategories of the next level.

ItemViewCategoriesList3Item
Functions

These functions are available in this container.

ButtonAddBasket1Small( string $_buttonValue  ) : string
ButtonAddBasketOverlay( string $_buttonValue  ) : string
GetBarcode( string $_barcodeName  ) : string
GetDocumentLinks( string '$_fileExtension'  ) :
GetItemViewStockList( int $ID  ) :
Link_CurrentCategory() : string
Variables

These variables are available in this container.

  • $ASIN — Contains an item’s first Amazon Standard Ident Number (ASIN).

  • $ActionId — Contains the online store special’s ID.

  • $AttributeExist — Contains a query that checks if an item has attributes.

  • $AttributeMatrix — Contains all variations of an item. These are displayed in a table in which customers can also enter the order quantity. Insert the variable in the section between FormOpenOrder and FormCloseOrder for the entered order quantity to be placed in the shopping cart. We recommend that you use the variable for a small number of attributes and attribute values only.

  • $AttributeSelect — Contains one drop-down list per attribute that contains an item’s attribute values. The attribute name is displayed above the drop-down list. The attribute values can be selected in a drop-down list.

  • $AttributeSelectWithoutAttributeName — Contains one drop-down list per attribute that contains the item’s attribute values.

  • $AvailabilityIcon — Contains the availability icon for the item availability. An icon is saved in the Setup » Item » Availability menu.

  • $AvailabilityId — Contains the ID of the item availability (1-10).

  • $AvailabilityString — Contains the name of the item availability. The names are saved in the Setup » Item » Availability menu.

  • $BasePrice — Contains an item’s unit price.

  • $BasePriceLot — Contains the price of an item’s sales unit.

  • $BasePriceUnit — Contains the unit for the unit price.

  • $CategoryId[Level1] …​$CategoryId[Level6] — Contains the ID of the item’s default category.

  • $CategoryName[Level1] …​$CategoryName[Level6] — Contains the name of the category.

  • $Condition — Contains the item condition.

  • $CreationDate — Contains an item’s creation date.

  • $DefaultShippingCost

  • $Description — Contains the item text.

  • $DescriptionShort — Contains the item preview text.

  • $EAN — Contains an item’s EAN 1.

  • $ExpirationDate — Contains an item’s expiration date ("available until").

  • $FSK — Contains an item’s age rating.

  • $FlashHeight — Contains the height of an item’s flash file.

  • $FlashURL — Contains the URL of an item’s flash file.

  • $FlashWidth — Contains the width of an item’s flash file.

  • $FormCloseOrder — Contains an item’s closing HTML form.

  • $FormOpenOrder — Contains an item’s opening HTML form.

  • $Free[1] …​$Free[20] — Contains the item free text fields.

  • $Height — Contains an item’s height.

  • $ID — Contains the item ID.

  • $ISBN — Contains the item’s International Standard Book Number (ISBN).

  • $Image[1] …​$Image[25] — HTML image tag of the images with the highest resolution.

  • $ImageAlt[1] …​$ImageAlt[25] — Contains the item image’s alternative text.

  • $ImageAttributeList — Contains an item’s attribute values as images. The images are linked to the attribute values in the item’s Images tab.

  • $ImageName[1] …​$ImageName[25] — Contains the item image’s name.

  • $ImageURL[1] …​$ImageURL[25] — URL of the images with the highest resolution.

  • $ItemAge — Contains an item’s age in days, starting from the date it was created in plentymarkets.

  • $ItemShipping[1] …​$ItemShipping[2] — Contains the item’s shipping costs.

  • $Length — Contains an item’s length.

  • $LimitOrderByStock — Contains the value for limiting the item to the stock; 0 = No limitation, 1 = Limited to net stock, 2 = Do not administer stock for this item.

  • $Lot — Contains the content of an item’s sales unit.

  • $MiddleSizeImage[1] …​$MiddleSizeImage[25] — HTML image tag of the images with medium resolution.

  • $MiddleSizeImageURL[1] …​$MiddleSizeImageURL[25] — URL of the images with medium resolution.

  • $Model — Model

  • $Name[1] …​$Name[3] — Contains the item name.

  • $Name4URL — Contains the URL-conform item name.

  • $Number — Contains the item number.

  • $OrderQuantityInterval

  • $OrderQuantityMax — Contains the item’s maximum order quantity.

  • $OrderQuantityMin — Contains the item’s minimum order quantity.

  • $PackagingUnit — Contains an item’s packaging unit.

  • $Position

  • $PreviewImage[1] …​$PreviewImage[25] — Returns the current item’s preview image.

  • $PreviewImageURL[1] …​$PreviewImageURL[25] — Returns the URL of the current item’s preview image.

  • $Price — Contains an item’s price.

  • $PriceCount — Contains the number of an item’s price sets.

  • $PriceDecimalSeparatorDot — Contains an item’s price; decimal separator is a dot.

  • $PriceDynamic — Contains the price of an item or of a variation including surcharges etc. When using this variable, the item price is automatically adjusted based on the variation selected.

  • $PriceID — Contains the ID of the item’s price set.

  • $PriceRadioButton — All price sets are displayed and selected using radio buttons.

  • $PriceSelect — Selection of all price sets as HTML select.

  • $Producer — Contains the name of the item manufacturer.

  • $ProducerAddressCity

  • $ProducerAddressCountryID

  • $ProducerAddressCountryName

  • $ProducerAddressHouseNo

  • $ProducerAddressStreet

  • $ProducerAddressZip

  • $ProducerEmail

  • $ProducerExternalName

  • $ProducerFax

  • $ProducerLogo — Contains the manufacturer logo.

  • $ProducerPhone

  • $ProducerURL — Contains the URL of the manufacturer. The URL is saved in the manufacturer data set.

  • $RRP — Contains the item’s recommended retail price.

  • $RRPDecimalSeparatorDot — Contains the recommended retail price; decimal separator is a dot.

  • $Rating — Contains the feedback.

  • $RatingCount — Contains the number of feedbacks for an item.

  • $RatingImage — Contains the average feedback.

  • $RatingMax

  • $RebateAvailable — Contains a query that checks whether a discounted price exists for an item that the customer is eligible for.

  • $RebatesMinimumPrice

  • $RebatesMinimumPriceQuantity

  • $ReleaseDate — Contains the item’s release date.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $Saving — Contains the discount amount.

  • $SavingDecimalSeparatorDot — Contains the discount amount; decimal separator is a dot.

  • $SavingDynamic

  • $SavingDynamicDecimalSeparatorDot

  • $SavingDynamicPercent

  • $SavingPercent — Contains the discount rate in percent.

  • $SecondPreviewImage[1] …​$SecondPreviewImage[25] — Returns the current item’s second preview image.

  • $SecondPreviewImageURL[1] …​$SecondPreviewImageURL[25] — Returns the URL of the current item’s second preview image.

  • $ShortName — Contains a shorter version of the item name. The item name is truncated after a specific number of characters.

  • $Size — Contains the information in Unit 1 and Unit 2 of an item’s Base tab.

  • $StockList — Contains an item’s physical stock.

  • $TechnicalData — Contains the item’s technical data.

  • $UnitString/$UnitString[1] …​$UnitString[2] — Contains the item unit.

  • $VAT — Contains the item’s VAT in percent.

  • $VATHint — Contains the VAT note, e.g. "incl. statutory VAT".

  • $VariationID — Contains the variation’s ID.

  • $VolumePrice[1] …​$VolumePrice[10] — Contains the price for an item’s minimum order quantity.

  • $VolumePriceStartingQuantity[1] …​$VolumePriceStartingQuantity[10] — Contains the minimum order quantity for a discount to be applied to an item.

  • $Volumen — Contains an item’s volume.

  • $Weight — Contains an item’s weight.

  • $WeightNet — Contains an item’s net weight.

  • $Width — Contains an item’s width.

Examples

<div class="basketItems overlay">
    {% Container_ItemViewBasketPreviewList() %}
</div>

5.4.16. Container_ItemViewCategoriesList4

Short description

Returns the template ItemViewCategoriesList4. This template is used to display items of a category.

Description of this function
Container_ItemViewCategoriesList4(
int $ItemViewCategoriesList4_EachRow  ,
int $ItemViewCategoriesList4_ItemsPerPage  ,
int $ItemViewCategoriesList4_GroupByVariation  ,
int $ItemViewCategoriesList4_CatLevel1DefaultItemSorting  ,
int $ItemViewCategoriesList4_CatLevel2DefaultItemSorting
) : string
Template ItemViewCategoriesList4
Functions

These functions are available in this container.

BrowseNextButton( string $ItemViewCategoriesList4_BrowseNextButtonName  ) : string
BrowsePreviousButton( string $ItemViewCategoriesList4_BrowsePreviousButtonName  ) : string
CategoriesListItemsPerPageSelect( array [5,20,50,100]  , string "select"  , string "ItemsPerPageSelectClass"  ) : string
ItemSorting(
string "select"  ,
string "ItemSortingSelectClass"  ,
array [0, 1, 2, 7, 3, 4, 5, 6, 8, 13, 9]  ,
array ["Top Seller", "Artikelposition aufsteigend", "Name A-Z", "Name Z-A", "Hersteller", "Preis aufsteigend", "Preis absteigend", "Älteste Produkte", "Neuste Produkte", "Erscheinungsdatum aufsteigend", "Erscheinungsdatum absteigend"]
) : string
Link_ChangeCategoryListTemplate( int ) : string
Variables

These variables are available in this container.

  • $PageCount — Contains the number of pages returned.

  • $PageLinks — Contains the pagination.

  • $ProducerSelection — Contains check boxes to select a manufacturer. One manufacturer can be selected.

  • $ResultCount — Contains the number of the list elements returned.

  • $Subcategoryselect — Contains a drop-down list of the subcategories of the next level.

ItemViewCategoriesList4Item
Functions

These functions are available in this container.

ButtonAddBasket1Small( string $_buttonValue  ) : string
ButtonAddBasketOverlay( string $_buttonValue  ) : string
GetBarcode( string $_barcodeName  ) : string
GetDocumentLinks( string '$_fileExtension'  ) :
GetItemViewStockList( int $ID  ) :
Link_CurrentCategory() : string
Variables

These variables are available in this container.

  • $ASIN — Contains an item’s first Amazon Standard Ident Number (ASIN).

  • $ActionId — Contains the online store special’s ID.

  • $AttributeExist — Contains a query that checks if an item has attributes.

  • $AttributeMatrix — Contains all variations of an item. These are displayed in a table in which customers can also enter the order quantity. Insert the variable in the section between FormOpenOrder and FormCloseOrder for the entered order quantity to be placed in the shopping cart. We recommend that you use the variable for a small number of attributes and attribute values only.

  • $AttributeSelect — Contains one drop-down list per attribute that contains an item’s attribute values. The attribute name is displayed above the drop-down list. The attribute values can be selected in a drop-down list.

  • $AttributeSelectWithoutAttributeName — Contains one drop-down list per attribute that contains the item’s attribute values.

  • $AvailabilityIcon — Contains the availability icon for the item availability. An icon is saved in the Setup » Item » Availability menu.

  • $AvailabilityId — Contains the ID of the item availability (1-10).

  • $AvailabilityString — Contains the name of the item availability. The names are saved in the Setup » Item » Availability menu.

  • $BasePrice — Contains an item’s unit price.

  • $BasePriceLot — Contains the price of an item’s sales unit.

  • $BasePriceUnit — Contains the unit for the unit price.

  • $CategoryId[Level1] …​$CategoryId[Level6] — Contains the ID of the item’s default category.

  • $CategoryName[Level1] …​$CategoryName[Level6] — Contains the name of the category.

  • $Condition — Contains the item condition.

  • $CreationDate — Contains an item’s creation date.

  • $DefaultShippingCost

  • $Description — Contains the item text.

  • $DescriptionShort — Contains the item preview text.

  • $EAN — Contains an item’s EAN 1.

  • $ExpirationDate — Contains an item’s expiration date ("available until").

  • $FSK — Contains an item’s age rating.

  • $FlashHeight — Contains the height of an item’s flash file.

  • $FlashURL — Contains the URL of an item’s flash file.

  • $FlashWidth — Contains the width of an item’s flash file.

  • $FormCloseOrder — Contains an item’s closing HTML form.

  • $FormOpenOrder — Contains an item’s opening HTML form.

  • $Free[1] …​$Free[20] — Contains the item free text fields.

  • $Height — Contains an item’s height.

  • $ID — Contains the item ID.

  • $ISBN — Contains the item’s International Standard Book Number (ISBN).

  • $Image[1] …​$Image[25] — HTML image tag of the images with the highest resolution.

  • $ImageAlt[1] …​$ImageAlt[25] — Contains the item image’s alternative text.

  • $ImageAttributeList — Contains an item’s attribute values as images. The images are linked to the attribute values in the item’s Images tab.

  • $ImageName[1] …​$ImageName[25] — Contains the item image’s name.

  • $ImageURL[1] …​$ImageURL[25] — URL of the images with the highest resolution.

  • $ItemAge — Contains an item’s age in days, starting from the date it was created in plentymarkets.

  • $ItemShipping[1] …​$ItemShipping[2] — Contains the item’s shipping costs.

  • $Length — Contains an item’s length.

  • $LimitOrderByStock — Contains the value for limiting the item to the stock; 0 = No limitation, 1 = Limited to net stock, 2 = Do not administer stock for this item.

  • $Lot — Contains the content of an item’s sales unit.

  • $MiddleSizeImage[1] …​$MiddleSizeImage[25] — HTML image tag of the images with medium resolution.

  • $MiddleSizeImageURL[1] …​$MiddleSizeImageURL[25] — URL of the images with medium resolution.

  • $Model — Model

  • $Name[1] …​$Name[3] — Contains the item name.

  • $Name4URL — Contains the URL-conform item name.

  • $Number — Contains the item number.

  • $OrderQuantityInterval

  • $OrderQuantityMax — Contains the item’s maximum order quantity.

  • $OrderQuantityMin — Contains the item’s minimum order quantity.

  • $PackagingUnit — Contains an item’s packaging unit.

  • $Position

  • $PreviewImage[1] …​$PreviewImage[25] — Returns the current item’s preview image.

  • $PreviewImageURL[1] …​$PreviewImageURL[25] — Returns the URL of the current item’s preview image.

  • $Price — Contains an item’s price.

  • $PriceCount — Contains the number of an item’s price sets.

  • $PriceDecimalSeparatorDot — Contains an item’s price; decimal separator is a dot.

  • $PriceDynamic — Contains the price of an item or of a variation including surcharges etc. When using this variable, the item price is automatically adjusted based on the variation selected.

  • $PriceID — Contains the ID of the item’s price set.

  • $PriceRadioButton — All price sets are displayed and selected using radio buttons.

  • $PriceSelect — Selection of all price sets as HTML select.

  • $Producer — Contains the name of the item manufacturer.

  • $ProducerAddressCity

  • $ProducerAddressCountryID

  • $ProducerAddressCountryName

  • $ProducerAddressHouseNo

  • $ProducerAddressStreet

  • $ProducerAddressZip

  • $ProducerEmail

  • $ProducerExternalName

  • $ProducerFax

  • $ProducerLogo — Contains the manufacturer logo.

  • $ProducerPhone

  • $ProducerURL — Contains the URL of the manufacturer. The URL is saved in the manufacturer data set.

  • $RRP — Contains the item’s recommended retail price.

  • $RRPDecimalSeparatorDot — Contains the recommended retail price; decimal separator is a dot.

  • $Rating — Contains the feedback.

  • $RatingCount — Contains the number of feedbacks for an item.

  • $RatingImage — Contains the average feedback.

  • $RatingMax

  • $RebateAvailable — Contains a query that checks whether a discounted price exists for an item that the customer is eligible for.

  • $RebatesMinimumPrice

  • $RebatesMinimumPriceQuantity

  • $ReleaseDate — Contains the item’s release date.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $Saving — Contains the discount amount.

  • $SavingDecimalSeparatorDot — Contains the discount amount; decimal separator is a dot.

  • $SavingDynamic

  • $SavingDynamicDecimalSeparatorDot

  • $SavingDynamicPercent

  • $SavingPercent — Contains the discount rate in percent.

  • $SecondPreviewImage[1] …​$SecondPreviewImage[25] — Returns the current item’s second preview image.

  • $SecondPreviewImageURL[1] …​$SecondPreviewImageURL[25] — Returns the URL of the current item’s second preview image.

  • $ShortName — Contains a shorter version of the item name. The item name is truncated after a specific number of characters.

  • $Size — Contains the information in Unit 1 and Unit 2 of an item’s Base tab.

  • $StockList — Contains an item’s physical stock.

  • $TechnicalData — Contains the item’s technical data.

  • $UnitString/$UnitString[1] …​$UnitString[2] — Contains the item unit.

  • $VAT — Contains the item’s VAT in percent.

  • $VATHint — Contains the VAT note, e.g. "incl. statutory VAT".

  • $VariationID — Contains the variation’s ID.

  • $VolumePrice[1] …​$VolumePrice[10] — Contains the price for an item’s minimum order quantity.

  • $VolumePriceStartingQuantity[1] …​$VolumePriceStartingQuantity[10] — Contains the minimum order quantity for a discount to be applied to an item.

  • $Volumen — Contains an item’s volume.

  • $Weight — Contains an item’s weight.

  • $WeightNet — Contains an item’s net weight.

  • $Width — Contains an item’s width.

Examples

<div class="basketItems overlay">
    {% Container_ItemViewBasketPreviewList() %}
</div>

5.4.17. Container_ItemViewCategoriesList5

Short description

Returns the template ItemViewCategoriesList5. This template is used to display items of a category.

Description of this function
Container_ItemViewCategoriesList5(
int $ItemViewCategoriesList5_EachRow  ,
int $ItemViewCategoriesList5_ItemsPerPage  ,
int $ItemViewCategoriesList5_GroupByVariation  ,
int $ItemViewCategoriesList5_CatLevel1DefaultItemSorting  ,
int $ItemViewCategoriesList5_CatLevel2DefaultItemSorting
) : string
Template ItemViewCategoriesList5
Functions

These functions are available in this container.

BrowseNextButton( string $ItemViewCategoriesList5_BrowseNextButtonName  ) : string
BrowsePreviousButton( string $ItemViewCategoriesList5_BrowsePreviousButtonName  ) : string
CategoriesListItemsPerPageSelect( array [5,20,50,100]  , string "select"  , string "ItemsPerPageSelectClass"  ) : string
ItemSorting(
string "select"  ,
string "ItemSortingSelectClass"  ,
array [0, 1, 2, 7, 3, 4, 5, 6, 8, 13, 9]  ,
array ["Top Seller", "Artikelposition aufsteigend", "Name A-Z", "Name Z-A", "Hersteller", "Preis aufsteigend", "Preis absteigend", "Älteste Produkte", "Neuste Produkte", "Erscheinungsdatum aufsteigend", "Erscheinungsdatum absteigend"]
) : string
Link_ChangeCategoryListTemplate( int ) : string
Variables

These variables are available in this container.

  • $PageCount — Contains the number of pages returned.

  • $PageLinks — Contains the pagination.

  • $ProducerSelection — Contains check boxes to select a manufacturer. One manufacturer can be selected.

  • $ResultCount — Contains the number of the list elements returned.

  • $Subcategoryselect — Contains a drop-down list of the subcategories of the next level.

ItemViewCategoriesList5Item
Functions

These functions are available in this container.

ButtonAddBasket1Small( string $_buttonValue  ) : string
ButtonAddBasketOverlay( string $_buttonValue  ) : string
GetBarcode( string $_barcodeName  ) : string
GetDocumentLinks( string '$_fileExtension'  ) :
GetItemViewStockList( int $ID  ) :
Link_CurrentCategory() : string
Variables

These variables are available in this container.

  • $ASIN — Contains an item’s first Amazon Standard Ident Number (ASIN).

  • $ActionId — Contains the online store special’s ID.

  • $AttributeExist — Contains a query that checks if an item has attributes.

  • $AttributeMatrix — Contains all variations of an item. These are displayed in a table in which customers can also enter the order quantity. Insert the variable in the section between FormOpenOrder and FormCloseOrder for the entered order quantity to be placed in the shopping cart. We recommend that you use the variable for a small number of attributes and attribute values only.

  • $AttributeSelect — Contains one drop-down list per attribute that contains an item’s attribute values. The attribute name is displayed above the drop-down list. The attribute values can be selected in a drop-down list.

  • $AttributeSelectWithoutAttributeName — Contains one drop-down list per attribute that contains the item’s attribute values.

  • $AvailabilityIcon — Contains the availability icon for the item availability. An icon is saved in the Setup » Item » Availability menu.

  • $AvailabilityId — Contains the ID of the item availability (1-10).

  • $AvailabilityString — Contains the name of the item availability. The names are saved in the Setup » Item » Availability menu.

  • $BasePrice — Contains an item’s unit price.

  • $BasePriceLot — Contains the price of an item’s sales unit.

  • $BasePriceUnit — Contains the unit for the unit price.

  • $CategoryId[Level1] …​$CategoryId[Level6] — Contains the ID of the item’s default category.

  • $CategoryName[Level1] …​$CategoryName[Level6] — Contains the name of the category.

  • $Condition — Contains the item condition.

  • $CreationDate — Contains an item’s creation date.

  • $DefaultShippingCost

  • $Description — Contains the item text.

  • $DescriptionShort — Contains the item preview text.

  • $EAN — Contains an item’s EAN 1.

  • $ExpirationDate — Contains an item’s expiration date ("available until").

  • $FSK — Contains an item’s age rating.

  • $FlashHeight — Contains the height of an item’s flash file.

  • $FlashURL — Contains the URL of an item’s flash file.

  • $FlashWidth — Contains the width of an item’s flash file.

  • $FormCloseOrder — Contains an item’s closing HTML form.

  • $FormOpenOrder — Contains an item’s opening HTML form.

  • $Free[1] …​$Free[20] — Contains the item free text fields.

  • $Height — Contains an item’s height.

  • $ID — Contains the item ID.

  • $ISBN — Contains the item’s International Standard Book Number (ISBN).

  • $Image[1] …​$Image[25] — HTML image tag of the images with the highest resolution.

  • $ImageAlt[1] …​$ImageAlt[25] — Contains the item image’s alternative text.

  • $ImageAttributeList — Contains an item’s attribute values as images. The images are linked to the attribute values in the item’s Images tab.

  • $ImageName[1] …​$ImageName[25] — Contains the item image’s name.

  • $ImageURL[1] …​$ImageURL[25] — URL of the images with the highest resolution.

  • $ItemAge — Contains an item’s age in days, starting from the date it was created in plentymarkets.

  • $ItemShipping[1] …​$ItemShipping[2] — Contains the item’s shipping costs.

  • $Length — Contains an item’s length.

  • $LimitOrderByStock — Contains the value for limiting the item to the stock; 0 = No limitation, 1 = Limited to net stock, 2 = Do not administer stock for this item.

  • $Lot — Contains the content of an item’s sales unit.

  • $MiddleSizeImage[1] …​$MiddleSizeImage[25] — HTML image tag of the images with medium resolution.

  • $MiddleSizeImageURL[1] …​$MiddleSizeImageURL[25] — URL of the images with medium resolution.

  • $Model — Model

  • $Name[1] …​$Name[3] — Contains the item name.

  • $Name4URL — Contains the URL-conform item name.

  • $Number — Contains the item number.

  • $OrderQuantityInterval

  • $OrderQuantityMax — Contains the item’s maximum order quantity.

  • $OrderQuantityMin — Contains the item’s minimum order quantity.

  • $PackagingUnit — Contains an item’s packaging unit.

  • $Position

  • $PreviewImage[1] …​$PreviewImage[25] — Returns the current item’s preview image.

  • $PreviewImageURL[1] …​$PreviewImageURL[25] — Returns the URL of the current item’s preview image.

  • $Price — Contains an item’s price.

  • $PriceCount — Contains the number of an item’s price sets.

  • $PriceDecimalSeparatorDot — Contains an item’s price; decimal separator is a dot.

  • $PriceDynamic — Contains the price of an item or of a variation including surcharges etc. When using this variable, the item price is automatically adjusted based on the variation selected.

  • $PriceID — Contains the ID of the item’s price set.

  • $PriceRadioButton — All price sets are displayed and selected using radio buttons.

  • $PriceSelect — Selection of all price sets as HTML select.

  • $Producer — Contains the name of the item manufacturer.

  • $ProducerAddressCity

  • $ProducerAddressCountryID

  • $ProducerAddressCountryName

  • $ProducerAddressHouseNo

  • $ProducerAddressStreet

  • $ProducerAddressZip

  • $ProducerEmail

  • $ProducerExternalName

  • $ProducerFax

  • $ProducerLogo — Contains the manufacturer logo.

  • $ProducerPhone

  • $ProducerURL — Contains the URL of the manufacturer. The URL is saved in the manufacturer data set.

  • $RRP — Contains the item’s recommended retail price.

  • $RRPDecimalSeparatorDot — Contains the recommended retail price; decimal separator is a dot.

  • $Rating — Contains the feedback.

  • $RatingCount — Contains the number of feedbacks for an item.

  • $RatingImage — Contains the average feedback.

  • $RatingMax

  • $RebateAvailable — Contains a query that checks whether a discounted price exists for an item that the customer is eligible for.

  • $RebatesMinimumPrice

  • $RebatesMinimumPriceQuantity

  • $ReleaseDate — Contains the item’s release date.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $Saving — Contains the discount amount.

  • $SavingDecimalSeparatorDot — Contains the discount amount; decimal separator is a dot.

  • $SavingDynamic

  • $SavingDynamicDecimalSeparatorDot

  • $SavingDynamicPercent

  • $SavingPercent — Contains the discount rate in percent.

  • $SecondPreviewImage[1] …​$SecondPreviewImage[25] — Returns the current item’s second preview image.

  • $SecondPreviewImageURL[1] …​$SecondPreviewImageURL[25] — Returns the URL of the current item’s second preview image.

  • $ShortName — Contains a shorter version of the item name. The item name is truncated after a specific number of characters.

  • $Size — Contains the information in Unit 1 and Unit 2 of an item’s Base tab.

  • $StockList — Contains an item’s physical stock.

  • $TechnicalData — Contains the item’s technical data.

  • $UnitString/$UnitString[1] …​$UnitString[2] — Contains the item unit.

  • $VAT — Contains the item’s VAT in percent.

  • $VATHint — Contains the VAT note, e.g. "incl. statutory VAT".

  • $VariationID — Contains the variation’s ID.

  • $VolumePrice[1] …​$VolumePrice[10] — Contains the price for an item’s minimum order quantity.

  • $VolumePriceStartingQuantity[1] …​$VolumePriceStartingQuantity[10] — Contains the minimum order quantity for a discount to be applied to an item.

  • $Volumen — Contains an item’s volume.

  • $Weight — Contains an item’s weight.

  • $WeightNet — Contains an item’s net weight.

  • $Width — Contains an item’s width.

Examples

<div class="basketItems overlay">
    {% Container_ItemViewBasketPreviewList() %}
</div>

5.4.18. Container_ItemViewCategoriesList6

Short description

Returns the template ItemViewCategoriesList6. This template is used to display items of a category.

Description of this function
Container_ItemViewCategoriesList6(
int $ItemViewCategoriesList6_EachRow  ,
int $ItemViewCategoriesList6_ItemsPerPage  ,
int $ItemViewCategoriesList6_GroupByVariation  ,
int $ItemViewCategoriesList6_CatLevel1DefaultItemSorting  ,
int $ItemViewCategoriesList6_CatLevel2DefaultItemSorting
) : string
Template ItemViewCategoriesList6
Functions

These functions are available in this container.

BrowseNextButton( string $ItemViewCategoriesList6_BrowseNextButtonName  ) : string
BrowsePreviousButton( string $ItemViewCategoriesList6_BrowsePreviousButtonName  ) : string
CategoriesListItemsPerPageSelect( array [5,20,50,100]  , string "select"  , string "ItemsPerPageSelectClass"  ) : string
ItemSorting(
string "select"  ,
string "ItemSortingSelectClass"  ,
array [0, 1, 2, 7, 3, 4, 5, 6, 8, 13, 9]  ,
array ["Top Seller", "Artikelposition aufsteigend", "Name A-Z", "Name Z-A", "Hersteller", "Preis aufsteigend", "Preis absteigend", "Älteste Produkte", "Neuste Produkte", "Erscheinungsdatum aufsteigend", "Erscheinungsdatum absteigend"]
) : string
Link_ChangeCategoryListTemplate( int ) : string
Variables

These variables are available in this container.

  • $PageCount — Contains the number of pages returned.

  • $PageLinks — Contains the pagination.

  • $ProducerSelection — Contains check boxes to select a manufacturer. One manufacturer can be selected.

  • $ResultCount — Contains the number of the list elements returned.

  • $Subcategoryselect — Contains a drop-down list of the subcategories of the next level.

ItemViewCategoriesList6Item
Functions

These functions are available in this container.

ButtonAddBasket1Small( string $_buttonValue  ) : string
ButtonAddBasketOverlay( string $_buttonValue  ) : string
GetBarcode( string $_barcodeName  ) : string
GetDocumentLinks( string '$_fileExtension'  ) :
GetItemViewStockList( int $ID  ) :
Link_CurrentCategory() : string
Variables

These variables are available in this container.

  • $ASIN — Contains an item’s first Amazon Standard Ident Number (ASIN).

  • $ActionId — Contains the online store special’s ID.

  • $AttributeExist — Contains a query that checks if an item has attributes.

  • $AttributeMatrix — Contains all variations of an item. These are displayed in a table in which customers can also enter the order quantity. Insert the variable in the section between FormOpenOrder and FormCloseOrder for the entered order quantity to be placed in the shopping cart. We recommend that you use the variable for a small number of attributes and attribute values only.

  • $AttributeSelect — Contains one drop-down list per attribute that contains an item’s attribute values. The attribute name is displayed above the drop-down list. The attribute values can be selected in a drop-down list.

  • $AttributeSelectWithoutAttributeName — Contains one drop-down list per attribute that contains the item’s attribute values.

  • $AvailabilityIcon — Contains the availability icon for the item availability. An icon is saved in the Setup » Item » Availability menu.

  • $AvailabilityId — Contains the ID of the item availability (1-10).

  • $AvailabilityString — Contains the name of the item availability. The names are saved in the Setup » Item » Availability menu.

  • $BasePrice — Contains an item’s unit price.

  • $BasePriceLot — Contains the price of an item’s sales unit.

  • $BasePriceUnit — Contains the unit for the unit price.

  • $CategoryId[Level1] …​$CategoryId[Level6] — Contains the ID of the item’s default category.

  • $CategoryName[Level1] …​$CategoryName[Level6] — Contains the name of the category.

  • $Condition — Contains the item condition.

  • $CreationDate — Contains an item’s creation date.

  • $DefaultShippingCost

  • $Description — Contains the item text.

  • $DescriptionShort — Contains the item preview text.

  • $EAN — Contains an item’s EAN 1.

  • $ExpirationDate — Contains an item’s expiration date ("available until").

  • $FSK — Contains an item’s age rating.

  • $FlashHeight — Contains the height of an item’s flash file.

  • $FlashURL — Contains the URL of an item’s flash file.

  • $FlashWidth — Contains the width of an item’s flash file.

  • $FormCloseOrder — Contains an item’s closing HTML form.

  • $FormOpenOrder — Contains an item’s opening HTML form.

  • $Free[1] …​$Free[20] — Contains the item free text fields.

  • $Height — Contains an item’s height.

  • $ID — Contains the item ID.

  • $ISBN — Contains the item’s International Standard Book Number (ISBN).

  • $Image[1] …​$Image[25] — HTML image tag of the images with the highest resolution.

  • $ImageAlt[1] …​$ImageAlt[25] — Contains the item image’s alternative text.

  • $ImageAttributeList — Contains an item’s attribute values as images. The images are linked to the attribute values in the item’s Images tab.

  • $ImageName[1] …​$ImageName[25] — Contains the item image’s name.

  • $ImageURL[1] …​$ImageURL[25] — URL of the images with the highest resolution.

  • $ItemAge — Contains an item’s age in days, starting from the date it was created in plentymarkets.

  • $ItemShipping[1] …​$ItemShipping[2] — Contains the item’s shipping costs.

  • $Length — Contains an item’s length.

  • $LimitOrderByStock — Contains the value for limiting the item to the stock; 0 = No limitation, 1 = Limited to net stock, 2 = Do not administer stock for this item.

  • $Lot — Contains the content of an item’s sales unit.

  • $MiddleSizeImage[1] …​$MiddleSizeImage[25] — HTML image tag of the images with medium resolution.

  • $MiddleSizeImageURL[1] …​$MiddleSizeImageURL[25] — URL of the images with medium resolution.

  • $Model — Model

  • $Name[1] …​$Name[3] — Contains the item name.

  • $Name4URL — Contains the URL-conform item name.

  • $Number — Contains the item number.

  • $OrderQuantityInterval

  • $OrderQuantityMax — Contains the item’s maximum order quantity.

  • $OrderQuantityMin — Contains the item’s minimum order quantity.

  • $PackagingUnit — Contains an item’s packaging unit.

  • $Position

  • $PreviewImage[1] …​$PreviewImage[25] — Returns the current item’s preview image.

  • $PreviewImageURL[1] …​$PreviewImageURL[25] — Returns the URL of the current item’s preview image.

  • $Price — Contains an item’s price.

  • $PriceCount — Contains the number of an item’s price sets.

  • $PriceDecimalSeparatorDot — Contains an item’s price; decimal separator is a dot.

  • $PriceDynamic — Contains the price of an item or of a variation including surcharges etc. When using this variable, the item price is automatically adjusted based on the variation selected.

  • $PriceID — Contains the ID of the item’s price set.

  • $PriceRadioButton — All price sets are displayed and selected using radio buttons.

  • $PriceSelect — Selection of all price sets as HTML select.

  • $Producer — Contains the name of the item manufacturer.

  • $ProducerAddressCity

  • $ProducerAddressCountryID

  • $ProducerAddressCountryName

  • $ProducerAddressHouseNo

  • $ProducerAddressStreet

  • $ProducerAddressZip

  • $ProducerEmail

  • $ProducerExternalName

  • $ProducerFax

  • $ProducerLogo — Contains the manufacturer logo.

  • $ProducerPhone

  • $ProducerURL — Contains the URL of the manufacturer. The URL is saved in the manufacturer data set.

  • $RRP — Contains the item’s recommended retail price.

  • $RRPDecimalSeparatorDot — Contains the recommended retail price; decimal separator is a dot.

  • $Rating — Contains the feedback.

  • $RatingCount — Contains the number of feedbacks for an item.

  • $RatingImage — Contains the average feedback.

  • $RatingMax

  • $RebateAvailable — Contains a query that checks whether a discounted price exists for an item that the customer is eligible for.

  • $RebatesMinimumPrice

  • $RebatesMinimumPriceQuantity

  • $ReleaseDate — Contains the item’s release date.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $Saving — Contains the discount amount.

  • $SavingDecimalSeparatorDot — Contains the discount amount; decimal separator is a dot.

  • $SavingDynamic

  • $SavingDynamicDecimalSeparatorDot

  • $SavingDynamicPercent

  • $SavingPercent — Contains the discount rate in percent.

  • $SecondPreviewImage[1] …​$SecondPreviewImage[25] — Returns the current item’s second preview image.

  • $SecondPreviewImageURL[1] …​$SecondPreviewImageURL[25] — Returns the URL of the current item’s second preview image.

  • $ShortName — Contains a shorter version of the item name. The item name is truncated after a specific number of characters.

  • $Size — Contains the information in Unit 1 and Unit 2 of an item’s Base tab.

  • $StockList — Contains an item’s physical stock.

  • $TechnicalData — Contains the item’s technical data.

  • $UnitString/$UnitString[1] …​$UnitString[2] — Contains the item unit.

  • $VAT — Contains the item’s VAT in percent.

  • $VATHint — Contains the VAT note, e.g. "incl. statutory VAT".

  • $VariationID — Contains the variation’s ID.

  • $VolumePrice[1] …​$VolumePrice[10] — Contains the price for an item’s minimum order quantity.

  • $VolumePriceStartingQuantity[1] …​$VolumePriceStartingQuantity[10] — Contains the minimum order quantity for a discount to be applied to an item.

  • $Volumen — Contains an item’s volume.

  • $Weight — Contains an item’s weight.

  • $WeightNet — Contains an item’s net weight.

  • $Width — Contains an item’s width.

Examples

<div class="basketItems overlay">
    {% Container_ItemViewBasketPreviewList() %}
</div>

5.4.19. Container_ItemViewCategoriesList7

Short description

Returns the template ItemViewCategoriesList7. This template is used to display items of a category.

Description of this function
Container_ItemViewCategoriesList7(
int $ItemViewCategoriesList7_EachRow  ,
int $ItemViewCategoriesList7_ItemsPerPage  ,
int $ItemViewCategoriesList7_GroupByVariation  ,
int $ItemViewCategoriesList7_CatLevel1DefaultItemSorting  ,
int $ItemViewCategoriesList7_CatLevel2DefaultItemSorting
) : string
Template ItemViewCategoriesList7
Functions

These functions are available in this container.

BrowseNextButton( string $ItemViewCategoriesList7_BrowseNextButtonName  ) : string
BrowsePreviousButton( string $ItemViewCategoriesList7_BrowsePreviousButtonName  ) : string
CategoriesListItemsPerPageSelect( array [5,20,50,100]  , string "select"  , string "ItemsPerPageSelectClass"  ) : string
ItemSorting(
string "select"  ,
string "ItemSortingSelectClass"  ,
array [0, 1, 2, 7, 3, 4, 5, 6, 8, 13, 9]  ,
array ["Top Seller", "Artikelposition aufsteigend", "Name A-Z", "Name Z-A", "Hersteller", "Preis aufsteigend", "Preis absteigend", "Älteste Produkte", "Neuste Produkte", "Erscheinungsdatum aufsteigend", "Erscheinungsdatum absteigend"]
) : string
Link_ChangeCategoryListTemplate( int ) : string
Variables

These variables are available in this container.

  • $PageCount — Contains the number of pages returned.

  • $PageLinks — Contains the pagination.

  • $ProducerSelection — Contains check boxes to select a manufacturer. One manufacturer can be selected.

  • $ResultCount — Contains the number of the list elements returned.

  • $Subcategoryselect — Contains a drop-down list of the subcategories of the next level.

ItemViewCategoriesList7Item
Functions

These functions are available in this container.

ButtonAddBasket1Small( string $_buttonValue  ) : string
ButtonAddBasketOverlay( string $_buttonValue  ) : string
GetBarcode( string $_barcodeName  ) : string
GetDocumentLinks( string '$_fileExtension'  ) :
GetItemViewStockList( int $ID  ) :
Link_CurrentCategory() : string
Variables

These variables are available in this container.

  • $ASIN — Contains an item’s first Amazon Standard Ident Number (ASIN).

  • $ActionId — Contains the online store special’s ID.

  • $AttributeExist — Contains a query that checks if an item has attributes.

  • $AttributeMatrix — Contains all variations of an item. These are displayed in a table in which customers can also enter the order quantity. Insert the variable in the section between FormOpenOrder and FormCloseOrder for the entered order quantity to be placed in the shopping cart. We recommend that you use the variable for a small number of attributes and attribute values only.

  • $AttributeSelect — Contains one drop-down list per attribute that contains an item’s attribute values. The attribute name is displayed above the drop-down list. The attribute values can be selected in a drop-down list.

  • $AttributeSelectWithoutAttributeName — Contains one drop-down list per attribute that contains the item’s attribute values.

  • $AvailabilityIcon — Contains the availability icon for the item availability. An icon is saved in the Setup » Item » Availability menu.

  • $AvailabilityId — Contains the ID of the item availability (1-10).

  • $AvailabilityString — Contains the name of the item availability. The names are saved in the Setup » Item » Availability menu.

  • $BasePrice — Contains an item’s unit price.

  • $BasePriceLot — Contains the price of an item’s sales unit.

  • $BasePriceUnit — Contains the unit for the unit price.

  • $CategoryId[Level1] …​$CategoryId[Level6] — Contains the ID of the item’s default category.

  • $CategoryName[Level1] …​$CategoryName[Level6] — Contains the name of the category.

  • $Condition — Contains the item condition.

  • $CreationDate — Contains an item’s creation date.

  • $DefaultShippingCost

  • $Description — Contains the item text.

  • $DescriptionShort — Contains the item preview text.

  • $EAN — Contains an item’s EAN 1.

  • $ExpirationDate — Contains an item’s expiration date ("available until").

  • $FSK — Contains an item’s age rating.

  • $FlashHeight — Contains the height of an item’s flash file.

  • $FlashURL — Contains the URL of an item’s flash file.

  • $FlashWidth — Contains the width of an item’s flash file.

  • $FormCloseOrder — Contains an item’s closing HTML form.

  • $FormOpenOrder — Contains an item’s opening HTML form.

  • $Free[1] …​$Free[20] — Contains the item free text fields.

  • $Height — Contains an item’s height.

  • $ID — Contains the item ID.

  • $ISBN — Contains the item’s International Standard Book Number (ISBN).

  • $Image[1] …​$Image[25] — HTML image tag of the images with the highest resolution.

  • $ImageAlt[1] …​$ImageAlt[25] — Contains the item image’s alternative text.

  • $ImageAttributeList — Contains an item’s attribute values as images. The images are linked to the attribute values in the item’s Images tab.

  • $ImageName[1] …​$ImageName[25] — Contains the item image’s name.

  • $ImageURL[1] …​$ImageURL[25] — URL of the images with the highest resolution.

  • $ItemAge — Contains an item’s age in days, starting from the date it was created in plentymarkets.

  • $ItemShipping[1] …​$ItemShipping[2] — Contains the item’s shipping costs.

  • $Length — Contains an item’s length.

  • $LimitOrderByStock — Contains the value for limiting the item to the stock; 0 = No limitation, 1 = Limited to net stock, 2 = Do not administer stock for this item.

  • $Lot — Contains the content of an item’s sales unit.

  • $MiddleSizeImage[1] …​$MiddleSizeImage[25] — HTML image tag of the images with medium resolution.

  • $MiddleSizeImageURL[1] …​$MiddleSizeImageURL[25] — URL of the images with medium resolution.

  • $Model — Model

  • $Name[1] …​$Name[3] — Contains the item name.

  • $Name4URL — Contains the URL-conform item name.

  • $Number — Contains the item number.

  • $OrderQuantityInterval

  • $OrderQuantityMax — Contains the item’s maximum order quantity.

  • $OrderQuantityMin — Contains the item’s minimum order quantity.

  • $PackagingUnit — Contains an item’s packaging unit.

  • $Position

  • $PreviewImage[1] …​$PreviewImage[25] — Returns the current item’s preview image.

  • $PreviewImageURL[1] …​$PreviewImageURL[25] — Returns the URL of the current item’s preview image.

  • $Price — Contains an item’s price.

  • $PriceCount — Contains the number of an item’s price sets.

  • $PriceDecimalSeparatorDot — Contains an item’s price; decimal separator is a dot.

  • $PriceDynamic — Contains the price of an item or of a variation including surcharges etc. When using this variable, the item price is automatically adjusted based on the variation selected.

  • $PriceID — Contains the ID of the item’s price set.

  • $PriceRadioButton — All price sets are displayed and selected using radio buttons.

  • $PriceSelect — Selection of all price sets as HTML select.

  • $Producer — Contains the name of the item manufacturer.

  • $ProducerAddressCity

  • $ProducerAddressCountryID

  • $ProducerAddressCountryName

  • $ProducerAddressHouseNo

  • $ProducerAddressStreet

  • $ProducerAddressZip

  • $ProducerEmail

  • $ProducerExternalName

  • $ProducerFax

  • $ProducerLogo — Contains the manufacturer logo.

  • $ProducerPhone

  • $ProducerURL — Contains the URL of the manufacturer. The URL is saved in the manufacturer data set.

  • $RRP — Contains the item’s recommended retail price.

  • $RRPDecimalSeparatorDot — Contains the recommended retail price; decimal separator is a dot.

  • $Rating — Contains the feedback.

  • $RatingCount — Contains the number of feedbacks for an item.

  • $RatingImage — Contains the average feedback.

  • $RatingMax

  • $RebateAvailable — Contains a query that checks whether a discounted price exists for an item that the customer is eligible for.

  • $RebatesMinimumPrice

  • $RebatesMinimumPriceQuantity

  • $ReleaseDate — Contains the item’s release date.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $Saving — Contains the discount amount.

  • $SavingDecimalSeparatorDot — Contains the discount amount; decimal separator is a dot.

  • $SavingDynamic

  • $SavingDynamicDecimalSeparatorDot

  • $SavingDynamicPercent

  • $SavingPercent — Contains the discount rate in percent.

  • $SecondPreviewImage[1] …​$SecondPreviewImage[25] — Returns the current item’s second preview image.

  • $SecondPreviewImageURL[1] …​$SecondPreviewImageURL[25] — Returns the URL of the current item’s second preview image.

  • $ShortName — Contains a shorter version of the item name. The item name is truncated after a specific number of characters.

  • $Size — Contains the information in Unit 1 and Unit 2 of an item’s Base tab.

  • $StockList — Contains an item’s physical stock.

  • $TechnicalData — Contains the item’s technical data.

  • $UnitString/$UnitString[1] …​$UnitString[2] — Contains the item unit.

  • $VAT — Contains the item’s VAT in percent.

  • $VATHint — Contains the VAT note, e.g. "incl. statutory VAT".

  • $VariationID — Contains the variation’s ID.

  • $VolumePrice[1] …​$VolumePrice[10] — Contains the price for an item’s minimum order quantity.

  • $VolumePriceStartingQuantity[1] …​$VolumePriceStartingQuantity[10] — Contains the minimum order quantity for a discount to be applied to an item.

  • $Volumen — Contains an item’s volume.

  • $Weight — Contains an item’s weight.

  • $WeightNet — Contains an item’s net weight.

  • $Width — Contains an item’s width.

Examples

<div class="basketItems overlay">
    {% Container_ItemViewBasketPreviewList() %}
</div>

5.4.20. Container_ItemViewCategoriesList8

Short description

Returns the template ItemViewCategoriesList8. This template is used to display items of a category.

Description of this function
Container_ItemViewCategoriesList8(
int $ItemViewCategoriesList8_EachRow  ,
int $ItemViewCategoriesList8_ItemsPerPage  ,
int $ItemViewCategoriesList8_GroupByVariation  ,
int $ItemViewCategoriesList8_CatLevel1DefaultItemSorting  ,
int $ItemViewCategoriesList8_CatLevel2DefaultItemSorting
) : string
Template ItemViewCategoriesList8
Functions

These functions are available in this container.

BrowseNextButton( string $ItemViewCategoriesList8_BrowseNextButtonName  ) : string
BrowsePreviousButton( string $ItemViewCategoriesList8_BrowsePreviousButtonName  ) : string
CategoriesListItemsPerPageSelect( array [5,20,50,100]  , string "select"  , string "ItemsPerPageSelectClass"  ) : string
ItemSorting(
string "select"  ,
string "ItemSortingSelectClass"  ,
array [0, 1, 2, 7, 3, 4, 5, 6, 8, 13, 9]  ,
array ["Top Seller", "Artikelposition aufsteigend", "Name A-Z", "Name Z-A", "Hersteller", "Preis aufsteigend", "Preis absteigend", "Älteste Produkte", "Neuste Produkte", "Erscheinungsdatum aufsteigend", "Erscheinungsdatum absteigend"]
) : string
Link_ChangeCategoryListTemplate( int ) : string
Variables

These variables are available in this container.

  • $PageCount — Contains the number of pages returned.

  • $PageLinks — Contains the pagination.

  • $ProducerSelection — Contains check boxes to select a manufacturer. One manufacturer can be selected.

  • $ResultCount — Contains the number of the list elements returned.

  • $Subcategoryselect — Contains a drop-down list of the subcategories of the next level.

ItemViewCategoriesList8Item
Functions

These functions are available in this container.

ButtonAddBasket1Small( string $_buttonValue  ) : string
ButtonAddBasketOverlay( string $_buttonValue  ) : string
GetBarcode( string $_barcodeName  ) : string
GetDocumentLinks( string '$_fileExtension'  ) :
GetItemViewStockList( int $ID  ) :
Link_CurrentCategory() : string
Variables

These variables are available in this container.

  • $ASIN — Contains an item’s first Amazon Standard Ident Number (ASIN).

  • $ActionId — Contains the online store special’s ID.

  • $AttributeExist — Contains a query that checks if an item has attributes.

  • $AttributeMatrix — Contains all variations of an item. These are displayed in a table in which customers can also enter the order quantity. Insert the variable in the section between FormOpenOrder and FormCloseOrder for the entered order quantity to be placed in the shopping cart. We recommend that you use the variable for a small number of attributes and attribute values only.

  • $AttributeSelect — Contains one drop-down list per attribute that contains an item’s attribute values. The attribute name is displayed above the drop-down list. The attribute values can be selected in a drop-down list.

  • $AttributeSelectWithoutAttributeName — Contains one drop-down list per attribute that contains the item’s attribute values.

  • $AvailabilityIcon — Contains the availability icon for the item availability. An icon is saved in the Setup » Item » Availability menu.

  • $AvailabilityId — Contains the ID of the item availability (1-10).

  • $AvailabilityString — Contains the name of the item availability. The names are saved in the Setup » Item » Availability menu.

  • $BasePrice — Contains an item’s unit price.

  • $BasePriceLot — Contains the price of an item’s sales unit.

  • $BasePriceUnit — Contains the unit for the unit price.

  • $CategoryId[Level1] …​$CategoryId[Level6] — Contains the ID of the item’s default category.

  • $CategoryName[Level1] …​$CategoryName[Level6] — Contains the name of the category.

  • $Condition — Contains the item condition.

  • $CreationDate — Contains an item’s creation date.

  • $DefaultShippingCost

  • $Description — Contains the item text.

  • $DescriptionShort — Contains the item preview text.

  • $EAN — Contains an item’s EAN 1.

  • $ExpirationDate — Contains an item’s expiration date ("available until").

  • $FSK — Contains an item’s age rating.

  • $FlashHeight — Contains the height of an item’s flash file.

  • $FlashURL — Contains the URL of an item’s flash file.

  • $FlashWidth — Contains the width of an item’s flash file.

  • $FormCloseOrder — Contains an item’s closing HTML form.

  • $FormOpenOrder — Contains an item’s opening HTML form.

  • $Free[1] …​$Free[20] — Contains the item free text fields.

  • $Height — Contains an item’s height.

  • $ID — Contains the item ID.

  • $ISBN — Contains the item’s International Standard Book Number (ISBN).

  • $Image[1] …​$Image[25] — HTML image tag of the images with the highest resolution.

  • $ImageAlt[1] …​$ImageAlt[25] — Contains the item image’s alternative text.

  • $ImageAttributeList — Contains an item’s attribute values as images. The images are linked to the attribute values in the item’s Images tab.

  • $ImageName[1] …​$ImageName[25] — Contains the item image’s name.

  • $ImageURL[1] …​$ImageURL[25] — URL of the images with the highest resolution.

  • $ItemAge — Contains an item’s age in days, starting from the date it was created in plentymarkets.

  • $ItemShipping[1] …​$ItemShipping[2] — Contains the item’s shipping costs.

  • $Length — Contains an item’s length.

  • $LimitOrderByStock — Contains the value for limiting the item to the stock; 0 = No limitation, 1 = Limited to net stock, 2 = Do not administer stock for this item.

  • $Lot — Contains the content of an item’s sales unit.

  • $MiddleSizeImage[1] …​$MiddleSizeImage[25] — HTML image tag of the images with medium resolution.

  • $MiddleSizeImageURL[1] …​$MiddleSizeImageURL[25] — URL of the images with medium resolution.

  • $Model — Model

  • $Name[1] …​$Name[3] — Contains the item name.

  • $Name4URL — Contains the URL-conform item name.

  • $Number — Contains the item number.

  • $OrderQuantityInterval

  • $OrderQuantityMax — Contains the item’s maximum order quantity.

  • $OrderQuantityMin — Contains the item’s minimum order quantity.

  • $PackagingUnit — Contains an item’s packaging unit.

  • $Position

  • $PreviewImage[1] …​$PreviewImage[25] — Returns the current item’s preview image.

  • $PreviewImageURL[1] …​$PreviewImageURL[25] — Returns the URL of the current item’s preview image.

  • $Price — Contains an item’s price.

  • $PriceCount — Contains the number of an item’s price sets.

  • $PriceDecimalSeparatorDot — Contains an item’s price; decimal separator is a dot.

  • $PriceDynamic — Contains the price of an item or of a variation including surcharges etc. When using this variable, the item price is automatically adjusted based on the variation selected.

  • $PriceID — Contains the ID of the item’s price set.

  • $PriceRadioButton — All price sets are displayed and selected using radio buttons.

  • $PriceSelect — Selection of all price sets as HTML select.

  • $Producer — Contains the name of the item manufacturer.

  • $ProducerAddressCity

  • $ProducerAddressCountryID

  • $ProducerAddressCountryName

  • $ProducerAddressHouseNo

  • $ProducerAddressStreet

  • $ProducerAddressZip

  • $ProducerEmail

  • $ProducerExternalName

  • $ProducerFax

  • $ProducerLogo — Contains the manufacturer logo.

  • $ProducerPhone

  • $ProducerURL — Contains the URL of the manufacturer. The URL is saved in the manufacturer data set.

  • $RRP — Contains the item’s recommended retail price.

  • $RRPDecimalSeparatorDot — Contains the recommended retail price; decimal separator is a dot.

  • $Rating — Contains the feedback.

  • $RatingCount — Contains the number of feedbacks for an item.

  • $RatingImage — Contains the average feedback.

  • $RatingMax

  • $RebateAvailable — Contains a query that checks whether a discounted price exists for an item that the customer is eligible for.

  • $RebatesMinimumPrice

  • $RebatesMinimumPriceQuantity

  • $ReleaseDate — Contains the item’s release date.

  • $RowCount — Contains the position of the current line.

  • $RowCountModulo2 — Contains the value that specifies if the current line is divisible by 2 or not.

  • $Saving — Contains the discount amount.

  • $SavingDecimalSeparatorDot — Contains the discount amount; decimal separator is a dot.

  • $SavingDynamic

  • $SavingDynamicDecimalSeparatorDot

  • $SavingDynamicPercent

  • $SavingPercent — Contains the discount rate in percent.

  • $SecondPreviewImage[1] …​$SecondPreviewImage[25] — Returns the current item’s second preview image.

  • $SecondPreviewImageURL[1] …​$SecondPreviewImageURL[25] — Returns the URL of the current item’s second preview image.

  • $ShortName — Contains a shorter version of the item name. The item name is truncated after a specific number of characters.

  • $Size — Contains the information in Unit 1 and Unit 2 of an item’s Base tab.

  • $StockList — Contains an item’s physical stock.

  • $TechnicalData — Contains the item’s technical data.

  • $UnitString/$UnitString[1] …​$UnitString[2] — Contains the item unit.

  • $VAT — Contains the item’s VAT in percent.

  • $VATHint — Contains the VAT note, e.g. "incl. statutory VAT".

  • $VariationID — Contains the variation’s ID.

  • $VolumePrice[1] …​$VolumePrice[10] — Contains the price for an item’s minimum order quantity.

  • $VolumePriceStartingQuantity[1] …​$VolumePriceStartingQuantity[10] — Contains the minimum order quantity for a discount to be applied to an item.

  • $Volumen — Contains an item’s volume.

  • $Weight — Contains an item’s weight.

  • $WeightNet — Contains an item’s net weight.

  • $Width — Contains an item’s width.

Examples

<div class="basketItems overlay">
    {% Container_ItemViewBasketPreviewList() %}
</div>

5.4.21. Container_ItemViewCategoriesList9

Short description

Returns the template Ite