Settings
The plugin’s settings live on the Mirakl → Settings page, which has three tabs:
- Connections — per-marketplace rows (see Connections for the per-connection fields). Not covered here.
- Sync Settings — master switches, intervals and batch sizes that drive the background syncs.
- Options — log retention and levels.
These settings also appear under Shopware’s standard Settings → System → Plugins configuration page, but the dedicated Mirakl → Settings page is the recommended place to edit them.
Sync Settings tab
Section titled “Sync Settings tab”The Sync Settings tab is split into three cards: Sync Settings, Document Sync (Mirakl → Shopware) and Invoicing & Transaction Logs Sync.
Master switches
Section titled “Master switches”Each sync has its own switch. When a switch is off, the scheduled task still fires on its interval but the handler simply skips it — no marketplace call is made. Switches don’t affect on-demand actions you trigger from the admin.
| UI label | Setting key | Default | What it enables |
|---|---|---|---|
| Enable Stock Sync | stockSyncActive | On | The stock-sync task pushes stock updates. |
| Enable Order Import | orderImportActive | On | The order-import task pulls new and updated orders. |
| Enable Product Export | productExportActive | On | The product-export task uploads queued products. |
| Enable Message Sync | messageSyncActive | Off | The message-sync task pulls new inbound messages. |
| Enable Order Document Sync (OR72) | orderDocumentSyncActive | Off | The order-document-sync task pulls new inbound documents. |
| Enable Document Requests Sync (DR11) | documentRequestSyncActive | Off | The document-request-sync task pulls new requests from the marketplace. |
| Enable Invoice Sync (IV01) | invoiceSyncActive | Off | The invoice-sync task pulls new invoices. |
| Enable Transaction Log Sync (TL02) | transactionLogSyncActive | Off | The transaction-log-sync task pulls new entries. |
Sync intervals
Section titled “Sync intervals”Each sync has a corresponding interval. The values are seconds; the UI shows them as preset durations.
| UI label | Setting key | Default | Preset values |
|---|---|---|---|
| Stock Sync Interval | stockSyncInterval | 15 minutes | 2 min, 5 min, 10 min, 15 min, 30 min, 60 min |
| Order Import Interval | orderImportInterval | 30 minutes | 2 min, 5 min, 10 min, 15 min, 30 min, 60 min |
| Product Export Interval | productExportInterval | 30 minutes | 2 min, 5 min, 10 min, 15 min, 30 min, 60 min |
| Message Sync Interval | messageSyncInterval | 30 minutes | 2 min, 5 min, 10 min, 15 min, 30 min, 60 min |
| Order Document Sync Interval | orderDocumentSyncInterval | 30 minutes | 5 min, 10 min, 15 min, 30 min, 60 min, 6 h, 24 h |
| Document Requests Sync Interval | documentRequestSyncInterval | 24 hours | 1 h, 6 h, 12 h, 24 h |
| Invoice Sync Interval | invoiceSyncInterval | 24 hours | 6 h, 12 h, 24 h |
| Transaction Log Sync Interval | transactionLogSyncInterval | 24 hours | 6 h, 12 h, 24 h |
| Transaction Log Export Poll Interval | transactionLogExportPollInterval | 1 minute | 30 sec, 1 min, 5 min |
The configured interval is a minimum — the actual gap also depends on how often the Shopware scheduler is fired on your host (cron cadence). See Background tasks.
Batch sizes
Section titled “Batch sizes”These two settings cap the number of rows uploaded in a single batch. Lower values reduce memory usage and timeout risk; higher values speed up large catalogues.
| UI label | Setting key | Default | Range |
|---|---|---|---|
| Product Export Batch Size | productExportBatchSize | 100 | 1–500 |
| Offer Sync Batch Size | offerSyncBatchSize | 50 | 1–500 |
The batch size is captured at the start of a run — if you change it mid-run, the change takes effect at the next run.
Closed-order cutoffs
Section titled “Closed-order cutoffs”For syncs that scan orders, these settings cap how far back to look on already-closed orders. They save marketplace quota on accounts with long order histories.
| UI label | Setting key | Default | Preset values |
|---|---|---|---|
| Sync messages for closed orders (days) | messageSyncClosedOrderDays | 7 days | 1, 3, 5, 7, 14, 30 |
| Sync documents for closed orders (days) | orderDocumentSyncClosedOrderDays | 30 days | 1, 3, 5, 7, 14, 30 |
Options tab
Section titled “Options tab”Logs card
Section titled “Logs card”| UI label | Setting key | Default | Effect |
|---|---|---|---|
| API Log Retention (days) | apiLogRetentionDays | 30 | How long to keep API Logs rows. Older rows are removed daily. |
| Sync Log Retention (days) | syncLogRetentionDays | 30 | How long to keep Sync Logs rows. Older rows are removed daily. |
| Sync log levels | syncLogLevels | Info, Success, Warning, Error (Debug off) | Which severity levels are kept. Long-running runs that get promoted to an unchecked level are removed on completion; one-off events at unchecked levels aren’t written. Unchecking every level switches sync logging off entirely. |
See Sync logs for the practical guidance on these.
Per-connection settings (not on the Settings page)
Section titled “Per-connection settings (not on the Settings page)”Several settings are stored per connection — they belong on the connection, not in the global system config. Edit them through the wizard or the row’s context menu on the Connections list.
| Setting | Where to edit |
|---|---|
| Initial order import date | Wizard step 12. |
| Default offer state | Wizard step 4, or Edit Connection modal. |
| Order status mapping | Wizard step 9, or context menu → Order Status Mapping. |
| Reverse status mapping | Wizard step 10, or context menu → Reverse Status Mapping. |
| Document auto-upload | Wizard step 11, or context menu → Document Auto-Upload. |
| Variant name format | Context menu → Variant Name Format. |
See Connections for the full list of per-connection fields.
Per-product overrides
Section titled “Per-product overrides”The Default Offer State on a connection can be overridden for individual products. Open the product (Catalogues → Products → select product) and go to the Specifications tab. In the Mirakl Marketplace section, each configured connection has its own Offer State (connection name) dropdown. Pick a value to override; leave it empty to keep the connection’s default.
Related
Section titled “Related”- Background tasks — how intervals and switches drive the scheduler
- Sync logs — how Sync log levels controls what shows there
- Enums — the values stored in entity status fields
- Connections — per-connection settings