cc009fec5cdd
v2-downloadOrderDocuments - Download documents from an order
<div class="extension-title">Description</div>Use this API to download documents from an order.
<div class="api-description-extension"> <div class="extension-title">Call Frequency</div> <div class="recommended-call-frequency">Recommended usage: On each order where we want to retrieve its documents</div> <div class="max-call-frequency">Maximum usage: On each order where we want to retrieve its documents</div> </div>Path parameters
Order identifier in Mirakl Connect
Query parameters
Filter by document types.
Cannot be used together with <code>document_ids</code>.
Filter by specific document IDs.
Only documents that exist and belong to the specified order will be returned. If some requested documents do not exist or do not belong to the order, they will be silently ignored. Returns 404 only if none of the requested documents are found or match the order.
Cannot be used together with <code>types</code>.
Response
The requested document(s).
Always returns a ZIP archive.
The ZIP archive contains all matching documents with their original filenames (sorted by most recent first). For example, if <code>0024_COMMERCIAL_ID-A</code> contains 3 documents the ZIP archive structure will be as follows:
<pre> <code> 0024_COMMERCIAL_ID-A_documents_1679996082000.zip ├── return_label.pdf ├── customer_invoice.pdf └── customer_invoice(1).pdf </code> </pre>Note: In case of multiple documents with the same name, a suffix (e.g. (1), (2), etc.) is added to the filenames in the ZIP archive to ensure uniqueness.