Sync logs

The plugin keeps two complementary logs so you can answer the question “what just happened?” without guessing:

• Sync Logs — one row per attempt to do something (export a batch of products, refresh categories, import orders). It tells you what was tried, how many items were processed and what failed.
• API Logs — one row per call sent to the marketplace. It contains the full request and response, the headers, the status and the timing. This is what you share with support when the marketplace says “we didn’t receive that”.

Each row in Sync Logs links to the API Logs entries it produced, so you can move from “this export failed” to the exact response the marketplace returned.

Where to find the lists

Open the Mirakl Dashboard. Under Quick Start you’ll find two tiles:

• Logs — opens the Sync Logs list.
• API Logs — opens the API Logs list.

Both lists let you filter by Connection, Type and the row’s success or level, and have a Refresh button at the top.

What a Sync Logs row tells you

The list shows these columns:

• Type — what the row recorded (for example Offer sync, Stock sync, Order import, Product export, Product export batch, Product import status check, Product import item error, Order state sync, Offer delete).
• Status — Started, Completed or Error.
• Level — Debug, Info, Success, Warning or Error.
• Connection — which marketplace the row belongs to.
• Import / Product — drill-down links to the marketplace-side import or to the affected product, when relevant.
• Message — a short, human-readable summary, for example “Import 123456: 47 lines, 0 errors”.
• Processed / Failed — item counts.
• Started / Duration — when the run started and how long it took.

Click View Details on a row to open the Log Details page with two tabs:

• Overview — the full message, context information, status and counts.
• Related Logs — the API Logs entries (the actual calls) that this run produced, plus links to related orders, imports and product imports.

When a row records a marketplace-side import job, the Import link takes you to the Imports list (Dashboard → Quick Start → Imports) where you can see its progress and any per-line errors the marketplace reported.

How rows are written

Two patterns produce rows:

Long-running runs (a batch upload, a refresh, an import check) write the row right away with status Started, then update it at the end:

• On success the row becomes Completed with level Success, and the completion time and final counts are filled in.
• On failure the row becomes Error with level Error, and the marketplace’s message is recorded.

One-off events (a single small thing was logged) write a row that is already Completed (or Error) at the moment it appears.

In both cases the plugin checks the row against your chosen Sync log levels (see below) before keeping it. If you’ve unchecked the level that the row would land on, the row isn’t kept — for one-off events that means no row is written, for long-running runs the row is removed at the end of the run.

The practical effect is the same: the list only contains the levels you’ve asked for.

Choosing what gets logged

Open Mirakl → Settings → Options and look at the Logs card. Three settings control the lists:

• Sync log levels — tick which severity levels to keep: Debug, Info, Success, Warning, Error. By default Info, Success, Warning and Error are on and Debug is off. If you only care about failures, untick Success — you’ll still see runs that are in progress (Started) and runs that failed (Error).
• Sync Log Retention (days) — how long to keep Sync Logs rows. The default is 30 days. Older rows are removed once a day.
• API Log Retention (days) — how long to keep API Logs rows. The default is 30 days. Older rows are removed once a day.

Unticking every sync log level switches the Sync Logs list off completely. That’s a debugging-only setting — don’t ship it to production.

Tips and gotchas

Tip

For high-volume sellers, untick Success under Sync log levels and lower the retention to 7–14 days. You still see runs that are in progress and runs that failed — the list just doesn’t fill up with successful routine work.

Caution

If the Sync Logs list keeps growing past your retention window, the daily cleanup task isn’t running. See Background tasks — without a working scheduled task runner on your host, none of the cleanups fire and the table grows forever.

Note

If a row has been Started for hours with no completion time, a background worker died part-way through the run (out of memory, container restart, killed process). The row won’t update itself — open the Related Logs tab and look at the linked API Logs entries to see how far the marketplace call got.

Note

Sync Logs link back to Shopware orders by ID. If you delete an order, the message stays in the list but the link to the order is dead.

Related

• Background tasks — what writes to the logs, and the daily cleanup that removes old rows
• Troubleshooting — how to use the logs when something has gone wrong
• Reference → Enums — every value that can appear in the Status, Level and Type columns