Fields and properties
This page lists the fields both sources deliver. In the builder you map them to the parts of your element.
Product
id | Internal identifier of the product in the shop. Unique, but not meant for visitors. |
name | Product name. |
article_no | Article number as maintained in the shop. |
description | Full description, contains HTML from the shop. |
short_description | Short description. |
stock | Stock level as a number. |
in_stock | Yes/no — more convenient for conditions in the builder than the numeric value. |
seo_url | Readable address of the product, relative to the shop. |
shop_url | Full address of the product in the shop — assembled from the shop base URL. The field for "go to product" links. |
created_at | Creation date. |
updated_at | Date of the last change. |
main_image | The first image of the product — the normal case for cards and grids. |
price | Price details, see below. |
images | All images as a list, with a maximum count. |
attributes | Attributes as a list. |
variations | Variations as a list. |
merkmale | Characteristics as a list. |
description contains the markup from the shop. If your element outputs the text
escaped, visitors will see the HTML tags. Use an element that allows HTML in that case, or
short_description.
Price
price_net | Net price as a number. |
price_gross | Gross price as a number. |
formatted_net | Net price as a ready-made string with currency. |
formatted_gross | Gross price as a ready-made string with currency. |
rrp | Recommended retail price, if maintained in the shop. |
has_discount | Yes/no — whether the price is below the recommended retail price. |
currency | Currency code from the plugin settings. |
On displaying prices: which price actually applies in the shop depends on customer group, tiered prices and promotions. This extension reads the stored default price. If your shop works with customer-group-dependent prices, check whether the display on the website matches — and point out where appropriate that the price in the shop is the binding one.
Image
id | Identifier of the image. |
sort_order | Order as maintained in the shop. |
url_small, url_medium, url_large | The three sizes JTL generates — each as a full address. |
All three addresses are assembled from the shop base URL. If it is not set, the images lead nowhere.
Attribute
id | Identifier of the attribute. |
name | Label — in the language from the plugin settings, if translated. |
value | Value. |
formatted | Label and value as a ready-made string. |
Variation
id | Identifier of the variation. |
article_no | Article number of the variation. |
stock | Stock level of the variation. |
in_stock | Yes/no. |
Characteristic
merkmal_id, merkmal_name | Identifier and label of the characteristic, "colour" for instance. |
wert_id, wert_name | Identifier and label of the value, "blue" for instance. |
sort_order | Order from the shop. |
Characteristics are optional in JTL. If your shop does not use them, the fields stay empty and the selection list in the builder is empty — that is not an error.
The field names merkmale, merkmal_id, merkmal_name,
wert_id and wert_name are German on purpose: they are the names JTL
itself uses, and renaming them would break every existing layout.
Applies to version 1.12.1.