Order documents

Mirakl operators keep a per-order set of documents — customer invoices, credit notes, shipping slips, customs invoices and so on. P2Lab Mirakl mirrors that set into Shopware on the order detail page and supports both directions: you can download a document the operator sent and you can upload one of your own. The plugin can also push Shopware-generated documents (such as the invoice PDF) automatically.

Where to find it

Open any Shopware order that was imported from Mirakl. The plugin adds a Mirakl tab to the standard order detail page; inside that tab there are three sub-tabs: Overview, Messages and Documents.

The Documents sub-tab shows a card titled Documents with two toolbar buttons:

• Sync — fetches the latest document list for this order from the operator right now.
• Upload document — opens the Upload document to Mirakl dialog.

What the list shows

The document grid has these columns:

• File name
• Type — what kind of document it is. Recognised types include Customer invoice, Customer credit note, Shipping slip, Customs invoice and Other. Each operator may use additional codes.
• Direction — Inbound (operator → Shopware) or Outbound (Shopware → operator).
• Source — Auto (Shopware) (sent automatically when Shopware generated a document), Manual (Shopware) (you uploaded it through the Upload document dialog), or Mirakl sync (downloaded from the operator).
• Status — where the document is in its life cycle: Pending, Uploading, Uploaded, Synced, Downloaded, Error.
• Size
• Created

Each row has these actions:

• Download — saves the file locally.
• Retry upload — appears only on outbound rows that failed.
• Show error details — opens a dialog with the operator’s response.
• Delete — removes the Shopware-side record.

Uploading a document

1. Click Upload document in the toolbar.
2. In Document type pick one of the operator’s allowed types.
3. In Files select the file or files to upload.
4. Click Upload.

The file is saved as a Pending outbound row and is sent to the operator in the background. On success the status moves to Uploaded or Synced.

Auto-upload from Shopware

The plugin can attach Shopware-generated PDFs to the matching Mirakl order automatically. When you generate a Shopware document (the invoice PDF, the delivery note, and so on) for an order that came from Mirakl:

1. The connection’s Document Auto-Upload mapping is checked — this is the table that says “Shopware Invoice corresponds to Mirakl Customer invoice”, and similar.
2. If a matching entry exists and the connection’s auto-upload switch is on, the generated PDF is added to the Documents list with Source = Auto (Shopware).
3. It is then uploaded to Mirakl in the background using the same flow as a manual upload.

You configure the mapping during the connection setup wizard (step 11) or any time later through the connection’s context menu in Mirakl → Settings → Connections → Document Auto-Upload.

The auto-upload removes the per-order manual click for the most common documents (the customer invoice in particular) and avoids operator escalations for missing files on high-volume connections.

Document requests

Operators can also issue document requests — formal asks like “please send me a customs declaration for this order by date X”. They are pulled separately and shown on their own page:

• Open Mirakl Dashboard → Quick Start → Document Requests. The page is titled Document requests (DR11).
• Each request has a State (Staging, To process, Issued, Canceled), a Type (Invoice or Credit note), a due date and a Fulfill (upload PDF/cXML) action that opens the Fulfill document request dialog.

Background sync

The plugin polls the operator for new documents on a schedule. The default interval is 30 minutes, and documents are still synced for orders that closed up to 30 days ago — closed orders may still get a final invoice or credit note within that window.

Document requests are polled separately, by default once per day (the operator’s recommendation).

For an on-the-spot refresh of one order, use the Sync button on the Documents card.

Initial import

The first time you turn on order import for a connection, the plugin also backfills the full document history for every order in the initial window. If the run is interrupted it resumes where it stopped, not from the start.

Configuration

Open Mirakl → Settings → Sync tab, Document Sync (Mirakl → Shopware) card:

• Enable Order Document Sync (OR72) — default off.
• Order Document Sync Interval — how often to fetch new documents. Presets from 5 minutes to 24 hours. Default 30 minutes.
• Sync documents for closed orders (days) — how many days after an order is closed to keep checking it for new documents. Presets 1 / 3 / 5 / 7 / 14 / 30 days. Default 30.
• Enable Document Requests Sync (DR11) — default off.
• Document Requests Sync Interval — presets from 1 hour to 24 hours. Default 24 hours.

Tips & gotchas

Tip

For high-volume sellers, set up the Document Auto-Upload mapping during the connection setup wizard (step 11), at minimum for Customer invoice. It removes a per-order manual step and avoids operator escalations for missing invoices.

Caution

Maximum file size and the accepted file types are set by each operator and can differ between marketplaces (typically a few megabytes per file, PDF / JPEG / PNG). Uploads above the limit fail and the operator’s exact response is shown via Show error details.

Note

Deleting a row from the Documents sub-tab deletes only the Shopware-side record. If the file was already uploaded to Mirakl and you want to retract it there, you have to do that from the operator’s seller panel.

Related

• Order messages — separate thread for free-form communication
• Invoices — operator-issued invoices (commissions, billing), a separate channel
• Sync logs
• Background tasks