Prints a list of order products.

Kuvaus

By default, order product details are printed in a <table> element, which includes the following information:

Apart from products, the potential discount row will also be printed on its own line, which is determined based on the coupon discounts and campaigns in use for the order.

With the attribute coupon:false, you can also prevent the discount row from being printed if necessary.

Line discounts are included in the price of each product to be printed.

You can modify the tag's output by specifying the desired content and markup in the helper attribute.

Syntaksi

{OrderProducts(
    coupon: boolean,
    helper: string,
    sort: string
)}

Attribuutit

coupon:

If the order has a discount applied, the attribute sets the discount to be printed as a product line among others.

Allowed values:true/false. Default value: true.

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.

sort:

Defines the sorting criteria for the list.

Allowed values:

  • 'default': the original order is maintained (default value)
  • 'product_code': products are organized by product codes
  • 'stock_place': arranges the products according to their stock places (useful on dispatch notes)
before: / after:

With these two attributes, you can define content that is output before or after the content produced by the tag.

Allowed values:text that may contain HTML and Interface markup.

E.g.

  • before: '<p>This markup appears before the tag's own content.</p>'.
  • after: '<p>This appears after the tag's own content.</p>'

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

between:

Defines the content that the tag prints between each list element.

The attribute enables, for example, formatting a product list as a JSON object by using a comma as the attribute value.

Sallitut arvot: a string and/or HTML/Interface markup
escape:

Adds escape characters to the content printed by the tag, making it easier to use the content in JavaScript code or JSON objects.

Sallitut arvot:
  • true: the attribute adds escape characters before quotation marks
  • false: the attribute does nothing
  • json: the attribute adds escape characters to the output, allowing the content to be used in JSON markup.
or:

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

Allowed values:text that may contain HTML and Interface markup.

E.g. or:'Content not found.'