EU legal guarantee and GARAN for PrestaShop: setup guide

Legal guarantee notice

• Show on the shop: the master switch for everything the module shows on the shop and adds to emails.
• Positions: product page, cart page and payment step, each with its style. Compact shows the official heading of the notice: one click opens the full notice in a window. Extended shows the full notice in the page.
• Checkout: directly above the order button: the notice and the GARAN labels of the payment step move from the top of the step to directly above the button that places the order. In Germany, § 312j (2) BGB asks for the information of the GARAN label directly before the order is placed: at installation the option is switched on for the shops that sell in German or deliver to Germany. PrestaShop 8 and 9 themes have a place for it; on PrestaShop 1.7, and on themes without that place, the block is printed under the button and moved above it in the browser. When the option is on and your theme calls neither displayCheckoutBeforeConfirmation nor displayPaymentByBinaries, a warning under the option tells you: the module then prints the blocks at the end of the page and moves them above the button in the browser, so check the payment step of your shop. If the theme does not call displayBeforeBodyClosingTag either, nothing is shown in the payment step while the option is on: switch it off to show the blocks at the top of the step. On a multistore installation, in the context of all shops or of a group, a warning names the shops and groups of shops that have their own value for this option.
• Footer and header bar: a link on every page that opens the notice.
• CMS page: choose a page (for example your terms of sale) and the full notice is added at its bottom.
• Dedicated page: always available, one address per language (for example /en/legal-guarantee). You can add it to a menu. Every link falls back to this page when the browser cannot open the window.
• Text version: under the official image there is always the same official text as real, resizable text, for screen readers and small screens. You can show it already open.
• Language versions: each shop language shows the official version of the same language automatically. You can choose another version for a language, and replace the heading of the compact link with your own words.
• Version for other languages: the notice exists only in the 24 official EU languages. A shop language without an official version (for example Catalan or Norwegian) shows the one chosen here.

Positions, dedicated page, text version and language versions

Order confirmation email, GARAN label and data

• Add the notice: the notice image, the link to the Your Europe page and the full text are added at the end of the email, in the language of the order.
• Email templates: order_conf is the order confirmation sent by PrestaShop. You can add other templates, separated by commas.
• Attachments: the official PDF of the notice and the GARAN label images of the ordered products can be attached, so the customer keeps a copy that does not depend on images loaded from your shop.
• GARAN labels: switches the GARAN labels on or off. Form, position and look of the label on the product page are chosen in the Appearance and positions tab (section 7); here you choose whether to show them also in the cart and in the payment step, directly before the order is placed.
• Uninstall: the GARAN data of products and combinations, the manufacturer templates and the order records are kept when you uninstall, unless you tick the delete option: in that case they are deleted and cannot be recovered, so export the order records first.

Order confirmation email, GARAN label and data

Click Save to apply your changes. On a multistore installation the settings follow the shop context selected in the back office.

Preview in the 24 languages

At the bottom of the settings page the preview shows every display (compact block, link, GARAN label with sample values, nested label, full notice). Pick any of the 24 official languages to check it before your customers see it. The panel above the preview lists the products that already have a GARAN label, with a link to edit each one.

Preview: compact block, link, GARAN label and full notice

Fill in the label only when the producer offers a commercial guarantee of durability at no additional cost, covering the entire good, for more than two years, and has given you this information. Open the product in the back office, tab Modules, panel GARAN label:

• Show the GARAN label for this product.
• Duration of the guarantee: whole years from 3 to 99, or half years from 2,5 to 9,5. Write half years with a comma, as they appear on the label (for example 2,5 or 4,5): the Commission guidelines allow half years and no other decimals.
• Producer (brand or trademark) and Model identifier, as given by the producer. They are prefilled with the brand and the MPN or reference of the product when available.

Click Save the GARAN data (the fields are also saved with the product). The label is drawn from the official template with the prescribed font and shown under the fields. If the producer name and the model identifier are too long to fit on the line of the label, the module asks you to shorten one of them: the font size is fixed by the Regulation.

The GARAN panel in the Modules tab of the product page

Own data or manufacturer template

If the manufacturer of the product has a template (section 4), the top of the panel shows Data of this product with two choices: Manufacturer template (the product shows the data of the template) or Own data for this product (the template does not change it) (the product keeps its own data). A line (Now applied) says what the product shows right now: the manufacturer template, its own data or nothing, for example when you removed the product from the template (choose Manufacturer template to link it again). The link Open the template opens the template. Data entered on the product always wins over the template.

The optional Producer address field holds the address of the producer: it is shown in small print under the label on the product page and in the email, and kept in the order records. If the product has combinations, the panel also contains the table of combinations (section 6).

When a manufacturer offers the same guarantee on all its products you do not need to fill in every product: in the Manufacturer templates tab you enter the data once per manufacturer. Click New template and fill in:

• Manufacturer: the manufacturer, chosen among those of the PrestaShop manufacturers list. Manufacturers that already have a template are not listed.
• Duration of the guarantee (years): whole years from 3 to 99, or half years from 2,5 to 9,5 written with a comma.
• Producer (brand or trademark): as the producer gives it, it is the name written on the label.
• Producer address: optional.
• Validity period (From and To): optional. The label is shown only between these dates, for example when the producer offers the guarantee for purchases made in a given period. Leave empty for no limit.
• Criteria: to activate the template you must confirm that the producer offers the guarantee at no additional cost, for the entire good, for more than two years, and gave you this information.
• Status and Applies to: the template can be active or not, and apply to all the products of the manufacturer, also those added later, or only to the products you select.

Save and update the products applies the template to the linked products straight away. The model identifier (Model identifier) comes from each product: the MPN, or the reference when the MPN is empty (the MPN exists from PrestaShop 1.7.7), and it is updated when you change the MPN or the reference of the product and save it. A product without an identifier, or with an identifier too long to fit next to the producer name on the label, shows no label until you fix it: the module lists them on the template page.

The list of templates and the form of a template

At the bottom of the template page, Products of this manufacturer lists the products (the first 300) with the state of their data: Linked (shows the data of the template), Own data (keeps its own), Removed (removed from a template that applies to all the products), No data, and whether the label is shown (Shown). With the buttons Link the selected products and Remove the selected products from the template you choose which products follow the template. A product removed from a template that applies to all the products stays out of it, also when the product or the template is saved again, until you link it again: with Link the selected products, by choosing Manufacturer template in its GARAN panel or with template in the CSV.

The products of the manufacturer: linked to the template, with own data, without data

In the Summary tab the list Manufacturers without a template takes you to a new template in one click (Create a template). Only producers that offer a commercial guarantee of durability of more than two years need one: the others can stay as they are.

For a large catalogue you can export and import the GARAN data as a CSV file, in the CSV import and export tab.

Export

The export holds the GARAN data of the current shop, one row per product or combination, with a semicolon as separator. Choose Products with GARAN data, or All products, to fill in, or download the template file with Download the template. The columns are:

id_product;id_product_attribute;reference;ean13;mpn;product_name;data_source;active;years;producer;model;producer_address

• data_source: product (own data of the product or combination, the default), template (links the product to the template of its manufacturer; on a multistore installation the manufacturer needs a template in every shop of the selected context) or remove (deletes the GARAN data; if the manufacturer has a template that applies to all the products, the product also leaves that template).
• active: 1 or 0. years: 3 to 99, or 2,5 to 9,5. product_name is ignored on import. The mpn column exists only from PrestaShop 1.7.7.

Import, in two steps

1. Check the file. Choose how to find the products (Find products by: id_product, reference, ean13 or mpn; a reference, EAN-13 or MPN of a combination finds the combination, while with id_product you target a combination by filling id_product_attribute) and upload the file: UTF-8, separated by semicolons or commas, with the column names in the first line, 4 MB and 20000 rows at most. The module checks every row and shows it with its result (Valid or Error with the explanation). It writes nothing.
2. Import the valid rows. The valid rows are written together: if a write fails, nothing is kept. Rows with errors are skipped: fix them in the file and import it again whenever you like.

The check of the file: every row with its result, before anything is written

A product with combinations can have a different guarantee for each combination, for example a more expensive version with a longer guarantee. In the GARAN panel of the product page you find the Combinations table, with one row per combination and a menu:

• Same as the product: the combination shows the label of the product (or of its template). This is the default.
• Own data: you fill in Years, Producer and Model identifier of the combination.
• No label: the combination shows no label, because it has no guarantee of durability.

On the product page the label follows the combination chosen by the customer: it changes when the customer changes size or colour. The cart, the payment step, the confirmation email and the order records use the combination that was ordered. In the CSV a combination is targeted with the id_product_attribute column.

The Appearance and positions tab sets how and where the GARAN label and the notice appear on the product page. Cart, payment step, footer and email are set in Settings.

The form of the label

In Form choose among three forms:

• Card: a box with the official strip of the label (the reduced version, called nested), the title, the duration, the producer and a Show details link. A click or a tap anywhere on the box, or a key on the keyboard, opens the full label, which can be enlarged. The link to the europa.eu page on guarantees of durability always stays visible.
• Nested label: the official strip alone; the full label opens on click or on mouse over.
• Full label: the whole label in the page.

On new installations the default form is the card. If you update from an earlier version, the look stays the one you had.

The look of the card

The card is text and a frame around the official files: the label itself is never changed. You can set:

• Accent colour: the colour of the title, the link and the frame. The official label keeps its own colours.
• Text colour: the colour of the text, or Use the text colour of the theme.
• Corners: Square, Soft or Round.
• Size of the nested label: Small (200 px), Medium (240 px) or Large (300 px). The smallest size keeps the duration and the GARAN text readable; on narrow screens the label never gets wider than the page.
• Frame: Box (a border with a coloured bar on the left), Plain (no frame) or Band (a strip with a light background and a coloured line on top).
• Texts: the title and the link text for each shop language, up to 120 characters. If you leave them empty the module uses its own texts, translated in English, Italian, French, Spanish, German, Polish and Dutch. In the other languages the title is the official wording of the label in your language (in English, “Producer guarantee in years”), the link texts are in the language of the label and the duration is written as a number only.

On the right, Live preview, sample values shows the result with sample values as you change the settings. Click Save at the bottom of the page to apply.

Form, position and look of the label, with the live preview on the right

The card on the product page, closed (left) and open with the full label (right)

The position

The label and the notice each have their own position on the product page (Position, in the two panels). The positions depend on the PrestaShop version:

• PrestaShop 1.7 and later: under the product pictures (displayAfterProductThumbs), under the price (displayProductPriceBlock), next to the Add to cart button (displayProductActions), in the additional information under the Add to cart area (displayProductAdditionalInfo), in the reassurance block (displayReassurance), at the bottom of the product page (displayFooterProduct).
• PrestaShop 1.6: under the short description (displayRightColumnProduct), under the price, under the Add to cart button (displayProductButtons), at the bottom of the product page.
• Hooks of your theme: the hooks that your theme already calls (see below).
• None: the module prints nothing by itself and you only use the displayCllLegalGuarantee hook that you write in your template.

The theme check

Under each position the module reads the templates of the theme in use and tells you whether the chosen hook appears in them: Your theme calls displayProductAdditionalInfo in followed by the files, or was not found in the templates of your theme with the suggestion to use the hook of the module. The check says that the theme calls the hook, not that the block is visible: open a product page to see it. If the templates of the theme cannot be read, the check is skipped.

The hook of the module and the hooks of your theme

If your theme does not have the position you need, write the hook of the module in a template of your theme. The Custom hook and hooks of your theme panel lists ready snippets, each with a Copy button:

{hook h='displayCllLegalGuarantee' show='garan'}
{hook h='displayCllLegalGuarantee' show='notice'}
{hook h='displayCllLegalGuarantee' show='both'}
{hook h='displayCllLegalGuarantee' show='garan' style='card' id_product=$product.id_product}

• show='garan' prints the GARAN label of the product of the page, show='notice' the link that opens the legal guarantee notice, show='both' both, notice first.
• The last snippet shows the label of a given product with a form different from the setting (full, nested or card). On PrestaShop 1.6 the product variable is $product->id.
• Under the snippets the module tells you whether the hook already appears in the templates of your theme.

If your theme already calls a hook of its own on the product page, type it in the Hooks of your theme field (up to 5 names separated by commas, each must start with display), choose Hooks of your theme as the position and save: the module hooks itself to that hook, and unhooks a name you remove.

The position of the notice with the theme check, the snippets of the module hook and the field for the hooks of your theme

Colours, corners, size and frame of the card are already set in the Appearance and positions tab (section 7). If your theme needs more, add rules to the custom.css file of the theme, so that a module update does not erase them. In PrestaShop 1.7 and later the file is themes/your-theme/assets/css/custom.css; on PrestaShop 1.6 use the stylesheet of your theme. All the classes start with the prefix cll-lg-.

The main classes

• .cll-lg-card: the box of the GARAN label on the product page. The choices made in Appearance are classes: .cll-lg-card--frame-card, --frame-plain, --frame-band (frame), --corners-square, --corners-soft, --corners-round (corners), --size-small, --size-medium, --size-large (size).
• The parts of the card: .cll-lg-card__head (the row you click), .cll-lg-card__title, .cll-lg-card__strip (the official strip), .cll-lg-card__years, .cll-lg-card__producer, .cll-lg-card__more (the “Show details” link), .cll-lg-card__panel (the open full label), .cll-lg-card__close, .cll-lg-card__enlarge, .cll-lg-card__address and .cll-lg-card__eu (the link to the europa.eu page).
• .cll-lg-garan--card: the container of the card, useful for the spacing around it.
• .cll-lg-trigger: the compact block of the notice, with .cll-lg-trigger__title and .cll-lg-trigger__text. .cll-lg-link is the notice as a link (footer and header), .cll-lg-notice is the extended notice on the dedicated page, .cll-lg-dialog is the window that opens it and .cll-lg-garan-list is the list of labels in the cart and in the payment step.

The CSS variables

• --cll-lg-accent: the colour of the title, the link and the frame of the card.
• --cll-lg-accent-soft: the light tint that the Band frame uses as background.
• --cll-lg-text: the text colour of the card. It exists only if you cleared Use the text colour of the theme.

The module writes the variables directly on the card (with the values chosen in Appearance), so in your custom.css they need !important:

/* accent colour of the card */
.cll-lg-card { --cll-lg-accent: #0b6b3a !important; }

/* text colour of the card */
.cll-lg-card { --cll-lg-text: #222222 !important; }

/* more room around the card and a slightly larger title */
.cll-lg-garan--card { margin: 24px 0; }
.cll-lg-card__title { font-size: 13px; }

/* compact notice block with the corners of your theme */
.cll-lg-trigger { border-radius: 8px; }

The notice and the GARAN label are information for consumers. In Settings, in the Business customers panel, you can choose not to show them to business customers by ticking Do not show the notice and the GARAN labels to business customers. The option is off by default. Visitors who are not logged in, and customers who order as guests, are always treated as consumers and see everything.

In Recognised as business when choose the criteria: one is enough.

• The customer belongs to one of the customer groups you tick.
• The customer account has a company name.
• The address has a VAT number (for an order: its invoice address).
• The customer is in the B2B group of the module B2B VAT (cll_b2b_vat). The entry is available when that module is installed; this module works without it.

The Business customers panel in Settings

How it works: in the cart, in the payment step and in the confirmation email the decision is taken by the server, on the customer of the order. On the pages that a cache can store (product page, header, footer) the blocks are printed for everyone and the browser hides them from a logged-in business customer, with a small cookie (cll_lg_b2b): a cached page never loses the blocks for a consumer. In the order records (section 10) a business customer appears as Business (blocks hidden).

For every order the module records what it showed to the customer: the language, the version and the file of the notice, the positions in use, the GARAN data of each product and combination with where it came from (product, template or combination), and whether the confirmation email carried the notice and the attachments. Recording never stops an order.

In Settings, in the Order records panel, Record every order switches recording on and Keep records for sets how many days to keep them: 0 means without a limit, and older records are deleted once a day. The legal guarantee lasts at least two years from delivery and a producer guarantee can last longer: choose the period with your advisor.

The Order records panel in Settings

Where to find it:

• On the order page in the back office, in the Legal guarantee: record of this order panel.
• In the Order records tab: the list of all recorded orders, which you can filter by date (From and To), with the Export CSV button.

On the order page: what the customer was shown

The Order records tab, with the CSV export

The email column shows the outcome: Notice added to the email, Not added: business customer, Email option off or No email with the notice yet. On PrestaShop 1.6, where modules cannot attach files to the confirmation email, the outcome of the second email with the attachments is shown too.

The scanner shows you where to look in your product texts. A result is not a verdict and the scanner does not make the shop compliant: read the text and decide. It searches the active products of the shop, in every active language, in name, summary, description, meta title, meta description and feature values, and points out two things:

• A, Promises a guarantee without GARAN data: the text talks about a guarantee of the producer, of durability, for life or longer than the two legal years, but the product and its combinations have no valid GARAN data. There are two ways out: fill in the GARAN data (product page, manufacturer template or CSV) or change the text.
• B, Legal guarantee presented as an advantage (to check): wordings such as “2 years warranty” or “legal guarantee included” used as a selling point. Directive 2005/29/EC on unfair commercial practices, Annex I, point 10, forbids presenting rights given to consumers by law as a distinctive feature of the offer. Check how the text presents them.

The Text scanner tab: the two kinds of results and the Run the scan button

Click Run the scan: the scan runs in blocks, with its progress, the results appear as soon as it ends and the page remembers the last scan. In the Results you can filter by type (All, A, B) and each row shows the product (with a link to its page), the language, the field, the word found and an excerpt with the word highlighted. Mark as checked removes the result from the next scans until the text of that field changes. Export CSV exports the results. On a multistore installation the scan runs on the shop of the selected context.

The results: product, language, field, word found, excerpt and type

The words per language

In Words searched, per language each shop language has its own lists, one per type, and each one searches only the texts of its own language. For English, Italian, French, Spanish and German they are already prepared: you can switch off a default word, add your own in Your words, one per line (up to 80 characters per entry and 100 entries per list) and go back to the starting lists with Restore the defaults of this language. For the other languages the module has only the wording of the official notice and label, which alone finds little: add the words of your language.

In the words you can use placeholders: {Y+} a number of years above 2, {Y-} up to 2 years, {M+} months above 24, {M-} up to 24 months, {N} any number, in digits or in letters. A space, a hyphen or a colon matches any of the three. Upper and lower case do not matter.

The word lists of a language: the default words can be switched off, yours are added below

Product page

The compact block shows the official heading of the notice. The GARAN label of the product appears in the position chosen in Appearance and positions (section 7), as a card, an official strip or the full label, with the link to the European Commission page on commercial guarantees of durability. The screenshots below show the strip under the pictures; the card is in section 7.

Product page on a desktop screen

One click opens the full official notice, with the Your Europe link, the PDF and the text version

The same on a phone (390 px wide)

Cart and payment step

The notice and the GARAN labels of the products in the cart are shown again in the cart and in the payment step, before the order is placed: at the top of the step, or directly above the button that places the order when the option Checkout: directly above the order button is on. Each nested label opens the full label.

Cart (left) and payment step with the block directly above the order button (right), on a phone

Footer link and dedicated page

The link in the footer, on every page

The dedicated page with the full notice

Order confirmation email

At the end of the order confirmation email: the notice in the language of the order, the link to Your Europe, the GARAN labels of the ordered products, and the official PDF of the notice attached.

The block added to the order confirmation email