Prints a list of loyalty program reward tiers.

Description

The tag will only output content if the loyalty program is active in the store version that the customer browses.

The tag does not have default content. The content of the list depends on the helper attribute, where the following tags can be used:

The tag lists the information included in the helper attribute by reward tier. By also using the filter attribute, the output can be limited to the customer's current or next reward tier.

Also read:

Syntax

{LoyaltyProgramDiscountTiers(
    filter: string,
    helper: string
)}

Scope

Required scope: globaali

Scope in helper attribute: loyalty-program-discount-tier

Tags with global scope can be used on any template and in any tag.

Implementing a reward tier listing for the loyalty program

Below is a simple example of a reward level listing as a <dl> element.

{LoyaltyProgramDiscountTiers(
	before: '
		<dl class="CustomerLoyaltyPointTiers">
			<dt>{CustomerLoyaltyPoints(or: '0')} {%Points}</dt>
	after: '
		</dl>'
	helper: '{{
		<dd class="{LoyaltyProgramDiscountTierClass}">{LoyaltyProgramDiscountTierDiscount}</dd>
		<dd>{%LoyaltyPointsToNextTier}</dd>
	}}'
)}

The before attribute with the {CustomerLoyaltyPoints} tag prints the customer's current point balance before the list. The details of the reward levels themselves are defined in the helper attribute using the reward levels' own tags.

Attribuutit

filter:

Limits the output to either the customer's current or next reward tier.

Allowed values:
  • current: Only the customer's current reward tier information is printed. The customer must be logged into the online store and at least at the lowest reward tier of the loyalty program, otherwise the tag will not print anything.
  • next: Only the details of the customer's next reward tier will be printed. If the customer is already at the top reward tier of the loyalty program, the tag will not print anything.
helper:

Defines the content and output format of a single list element.

Allowed values: the Interface and HTML markup that define the output's markup and content.

The helper attribute can be used in two ways:

  • you can indicate the desired markup directly as the attribute's value, or
  • you can indicate a reference to a file with the desired markup as the attribute's value.

    The reference should be indicated in relation to the theme's root directory.

See also detailed instructions on using the helper attribute.

after/before:

By using the after and before attributes you can define content that is output either after or before the tag's output.

Allowed values:HTML and Interface markup.

E.g.

  • before: '<p>Tämä merkkaus näkyy ennen tagin omaa sisältöä.</p>'
  • after: '<p>Tämä taas näkyy tagin oman sisällön jälkeen.</p>'

If the tag does not produce any content, neither the content of the after and before attributes will be output.

escape:

Adds an escape character before quotation marks in the output.

The attribute makes it easier to process the tag-produced content when using JavaScript.

Allowed values:true/false. The default value is false.

or:

Defines alternative content that is displayed if the tag itself does not produce any content.

Allowed values:HTML and Interface markup.

E.g. or:'Sisältöä ei löytynyt.'