Skip to content

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.

The Sync Settings tab is split into three cards: Sync Settings, Document Sync (Mirakl → Shopware) and Invoicing & Transaction Logs Sync.

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 labelSetting keyDefaultWhat it enables
Enable Stock SyncstockSyncActiveOnThe stock-sync task pushes stock updates.
Enable Order ImportorderImportActiveOnThe order-import task pulls new and updated orders.
Enable Product ExportproductExportActiveOnThe product-export task uploads queued products.
Enable Message SyncmessageSyncActiveOffThe message-sync task pulls new inbound messages.
Enable Order Document Sync (OR72)orderDocumentSyncActiveOffThe order-document-sync task pulls new inbound documents.
Enable Document Requests Sync (DR11)documentRequestSyncActiveOffThe document-request-sync task pulls new requests from the marketplace.
Enable Invoice Sync (IV01)invoiceSyncActiveOffThe invoice-sync task pulls new invoices.
Enable Transaction Log Sync (TL02)transactionLogSyncActiveOffThe transaction-log-sync task pulls new entries.

Each sync has a corresponding interval. The values are seconds; the UI shows them as preset durations.

UI labelSetting keyDefaultPreset values
Stock Sync IntervalstockSyncInterval15 minutes2 min, 5 min, 10 min, 15 min, 30 min, 60 min
Order Import IntervalorderImportInterval30 minutes2 min, 5 min, 10 min, 15 min, 30 min, 60 min
Product Export IntervalproductExportInterval30 minutes2 min, 5 min, 10 min, 15 min, 30 min, 60 min
Message Sync IntervalmessageSyncInterval30 minutes2 min, 5 min, 10 min, 15 min, 30 min, 60 min
Order Document Sync IntervalorderDocumentSyncInterval30 minutes5 min, 10 min, 15 min, 30 min, 60 min, 6 h, 24 h
Document Requests Sync IntervaldocumentRequestSyncInterval24 hours1 h, 6 h, 12 h, 24 h
Invoice Sync IntervalinvoiceSyncInterval24 hours6 h, 12 h, 24 h
Transaction Log Sync IntervaltransactionLogSyncInterval24 hours6 h, 12 h, 24 h
Transaction Log Export Poll IntervaltransactionLogExportPollInterval1 minute30 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.

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 labelSetting keyDefaultRange
Product Export Batch SizeproductExportBatchSize1001–500
Offer Sync Batch SizeofferSyncBatchSize501–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.

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 labelSetting keyDefaultPreset values
Sync messages for closed orders (days)messageSyncClosedOrderDays7 days1, 3, 5, 7, 14, 30
Sync documents for closed orders (days)orderDocumentSyncClosedOrderDays30 days1, 3, 5, 7, 14, 30
UI labelSetting keyDefaultEffect
API Log Retention (days)apiLogRetentionDays30How long to keep API Logs rows. Older rows are removed daily.
Sync Log Retention (days)syncLogRetentionDays30How long to keep Sync Logs rows. Older rows are removed daily.
Sync log levelssyncLogLevelsInfo, 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.

SettingWhere to edit
Initial order import dateWizard step 12.
Default offer stateWizard step 4, or Edit Connection modal.
Order status mappingWizard step 9, or context menu → Order Status Mapping.
Reverse status mappingWizard step 10, or context menu → Reverse Status Mapping.
Document auto-uploadWizard step 11, or context menu → Document Auto-Upload.
Variant name formatContext menu → Variant Name Format.

See Connections for the full list of per-connection fields.

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.

  • 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