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.
Before you start
Section titled “Before you start”- 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.
Install through the admin (ZIP upload)
Section titled “Install through the admin (ZIP upload)”- Download the plugin ZIP (
P2LabMirakl_vX.Y.Z.zip) from wherever you obtained the plugin. - In the Shopware admin go to Extensions → My extensions → Upload extension and pick the ZIP.
- After the upload, click Install next to the plugin entry. The plugin activates automatically on install — you do not need a separate Activate step.
- Reload the admin — a Mirakl entry should appear in the main sidebar under the Catalogues group.
Install from the command line
Section titled “Install from the command line”If you have shell access to the Shopware host, copy the plugin into custom/plugins/P2LabMirakl and run:
bin/console plugin:refreshbin/console plugin:install --activate P2LabMiraklbin/console cache:clearBackground workers
Section titled “Background workers”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:
bin/console messenger:consume asyncIn 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.
bin/console scheduled-task:runCheck that everything is in place
Section titled “Check that everything is in place”- Open the Shopware admin.
- The main sidebar — under the Catalogues group — should show a Mirakl entry with a blue shopping-bag icon.
- Click it. You land on the Dashboard.
- 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.
- 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.
- Switch to the Sync Settings tab — you should see the sync schedule controls.
- 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:clearor 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).
Where to find what
Section titled “Where to find what”Everything lives inside the Mirakl module. The Dashboard’s Quick Start card has a tile for every page:
| What | Where |
|---|---|
| Add, edit and run the setup wizard on a marketplace connection | Settings → Connections tab |
| Turn syncs on or off, adjust their schedule and batch sizes | Settings → Sync Settings tab |
| Log retention and detail level | Settings → Options tab |
| Marketplace category tree | Quick Start → Categories |
| How Shopware product fields fill marketplace attributes | Quick Start → Attribute Mappings |
| How Shopware product fields fill marketplace offer fields | Quick Start → Offer Field Mappings |
| The products you’ve chosen to send to the marketplace | Quick Start → Catalog |
| Live offers per marketplace | Quick Start → Offers |
| Marketplace orders that have become Shopware orders | Quick Start → Orders |
| Sync logs | Quick Start → Logs |
| Request / response logs for every call to the marketplace | Quick Start → API Logs |
| Running background jobs | Quick Start → Tasks |
| Catalogue import jobs on the Mirakl side | Quick Start → Imports |
| Catalogue export jobs created by the plugin | Quick Start → Product Exports |
| Invoices, Transaction Logs, Document Requests, Shipping Mappings | Quick Start → matching tile |
Next: connect Mirakl
Section titled “Next: connect Mirakl”The plugin is installed, but it doesn’t do anything until you give it your marketplace credentials. Continue with Connecting Mirakl.