Document Requests

Some Mirakl operators require sellers to upload an official invoice or credit note for every order, instead of generating it automatically from the marketplace. The operator sends these as document requests — one per order or credit note — and the plugin pulls them from the operator and lists them here.

This page lets you see which requests are open, what state each is in, and fulfil them by uploading the PDF or cXML file directly without leaving the Shopware admin.

Where to find it

From the Dashboard, open the Quick Start card and click the Document Requests tile. This opens the Document requests page.

What you see

Card title on the page: Document requests (DR11). Columns:

Column	Meaning
Request ID	The operator-side identifier of the request.
Type	Invoice or Credit note.
Entity type	What the request is tied to (typically the order).
State	One of Staging, To process, Issued, Canceled.
Document number	The document number you (or the operator) assigned.
Issue date	When the document was issued.
Due date	When the operator expects fulfilment.
Last updated	Last activity timestamp.
Connection	Which Mirakl connection this request belongs to.

The sidebar exposes:

Connection — filter by Mirakl connection.
State — filter by request state.
Type — filter by Invoice / Credit note.
Refresh — pulls the latest list.

Syncing requests from the operator

The toolbar has a Sync from Mirakl action. Clicking it opens the Sync document requests dialog — pick a Mirakl connection to sync from, confirm, and the plugin pulls every open request the operator currently has for that connection.

Document requests are also pulled automatically by the Document request sync scheduled task (off by default — enable it on Mirakl → Settings → Sync Settings if you want background polling).

Fulfilling a request

Rows in To process have a Fulfill (upload PDF/cXML) action. Clicking it opens the Fulfill document request dialog:

Document number — required.
Issue date — required.
Due date — optional.
Total (excl. tax) — optional.
Total tax — optional.
Files (PDF or cXML only) — the actual document attachment.

Confirm with Fulfill and the file is sent to the operator. The row moves to Issued once Mirakl accepts the upload.

State meaning

State	What it means
Staging	The operator is preparing the request — not yet actionable.
To process	Ready for you to fulfil. The Fulfill action is enabled.
Issued	You’ve fulfilled it; the operator has the file.
Canceled	The operator cancelled the request — no action required.

Tips & gotchas

Invoices — invoices the plugin pulls from the operator (different flow)
Order documents — documents attached to the order (carrier label, shipping slip, etc.)
Order import — how orders enter Shopware in the first place
Settings — turn on Document request sync for periodic background polling