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 line discount will be printed in a separate line. The discount is depends on the used discount coupons and campaigns.

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

Discount rows 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 )}

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. 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': 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)
before/after:

With the before and after 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.

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: text that may contain HTML and Interface markup.

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