Skip to content

Installation

P2Lab Mirakl is a normal Shopware 6 plugin. You install it the same way as any other plugin — through the admin Extensions page or from the command line.

  • Shopware 6.6 — the plugin is built for the 6.6 line.
  • A working background worker for the message queue (see Background workers below). Without it, nothing happens — the plugin uses background processing for every sync.
  • A working scheduled-task runner (also covered below). Without it, the recurring syncs never start by themselves.
  • A Mirakl seller account on at least one marketplace.
  1. Download the plugin ZIP (P2LabMirakl_vX.Y.Z.zip) from wherever you obtained the plugin.
  2. In the Shopware admin go to Extensions → My extensions → Upload extension and pick the ZIP.
  3. After the upload, click Install next to the plugin entry. The plugin activates automatically on install — you do not need a separate Activate step.
  4. Reload the admin — a Mirakl entry should appear in the main sidebar under the Catalogues group.

If you have shell access to the Shopware host, copy the plugin into custom/plugins/P2LabMirakl and run:

Terminal window
bin/console plugin:refresh
bin/console plugin:install --activate P2LabMirakl
bin/console cache:clear

The plugin uses Symfony Messenger for every long-running job — catalogue exports, offer and stock syncs, order, message, document and invoice imports, status polls and refresh tasks. Make sure the background worker is running before you trigger anything:

Terminal window
bin/console messenger:consume async

In production this should be a supervised process (systemd, supervisor or similar), so it restarts automatically. Without the worker, jobs pile up in the queue and the UI keeps showing tasks stuck in Queued state.

Equally important: the scheduled task runner. Without it, the recurring tasks (sending product changes out, pulling new orders, pulling messages, refreshing reference data and clearing old logs) never start.

Terminal window
bin/console scheduled-task:run
  1. Open the Shopware admin.
  2. The main sidebar — under the Catalogues group — should show a Mirakl entry with a blue shopping-bag icon.
  3. Click it. You land on the Dashboard.
  4. As long as you haven’t configured a marketplace yet, the Dashboard shows a Setup Status section with the next steps to take — Configure Connection, Configure Attribute Mappings, Map Categories, Add Products to Catalog, Add Products to Offers, Enable Sync — alongside a Quick Start card with tiles for every page.
  5. Click the Configure Connection step (or the Settings tile in Quick Start) — this opens Mirakl → Settings. The page has three tabs: Connections, Sync Settings and Options. The Connections list is empty until you create your first marketplace connection.
  6. Switch to the Sync Settings tab — you should see the sync schedule controls.
  7. Switch to the Options tab — you should see the log retention and detail-level settings.

If the Mirakl entry is missing from the sidebar, check:

  • The plugin is activated (Extensions → My extensions).
  • The admin cache has been cleared (either bin/console cache:clear or the Clear caches button in the admin).
  • Your admin user has access to the plugin’s permissions (the role’s Permissions settings; the relevant keys all start with p2lab_mirakl_).
  • The Shopware administration build is up to date (if you build it yourself).

Everything lives inside the Mirakl module. The Dashboard’s Quick Start card has a tile for every page:

WhatWhere
Add, edit and run the setup wizard on a marketplace connectionSettingsConnections tab
Turn syncs on or off, adjust their schedule and batch sizesSettingsSync Settings tab
Log retention and detail levelSettingsOptions tab
Marketplace category treeQuick StartCategories
How Shopware product fields fill marketplace attributesQuick StartAttribute Mappings
How Shopware product fields fill marketplace offer fieldsQuick StartOffer Field Mappings
The products you’ve chosen to send to the marketplaceQuick StartCatalog
Live offers per marketplaceQuick StartOffers
Marketplace orders that have become Shopware ordersQuick StartOrders
Sync logsQuick StartLogs
Request / response logs for every call to the marketplaceQuick StartAPI Logs
Running background jobsQuick StartTasks
Catalogue import jobs on the Mirakl sideQuick StartImports
Catalogue export jobs created by the pluginQuick StartProduct Exports
Invoices, Transaction Logs, Document Requests, Shipping MappingsQuick Start → matching tile

The plugin is installed, but it doesn’t do anything until you give it your marketplace credentials. Continue with Connecting Mirakl.