Prints a list of order products.

Kuvaus

By default, the order products' details are printed in a <table> element that contains the following details:

Apart from products, the potential line discount will be printed in a separate line. The discount is depends on the used discount coupons and campaigns.

If you don't want the discount line to be printed, use the coupon:false attribute.

The product prices to be printed are calculated taking into account line discounts.

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

Syntaksi

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

Näkyvyys

Toimii näkyvyydessä: tilaus

Näkyvyyshelper-attribuutissa: tilaustuote

The required scope is always set in the following templates:

Templates
Order confirmation page
Order confirmation
Shipping confirmation
Shipping delay notification
Ready for pickup notification
Payment confirmation
Pending payment reminder
Order cancellation notification
Receipt
Dispatch note
Shipping label

Attribuutit

coupon:

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

Allowed values:true/false. The default value is 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 how a list should be sorted.

Allowed values:

  • 'default': preserves the original order (default value)
  • 'product_code': arranges the products according to their product codes
  • 'stock_place': arranges the products according to their stock places (useful on dispatch notes)
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:The 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:The HTML and Interface markup

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