DR73 - Download accounting documents

Request

Description

At least one of the following filters must be applied: document_id or entity_id

If more than one document is requested, the output of the API will be a ZIP archive.

The tree structure of this archive is as follows:

documents-1624624030618.zip
|
|__ product-logistic-order/
    |__ order1-A/
    |   |__ INV203837.pdf
    |   |__ INV203837.cxml
    |__ order1-B/
        |__ INV203839.pdf

Security

Shop-API-Key(Required scopes: ROLE_SHOP_ADMIN)

Query

document_request_idArray of strings, [ 0 .. 100 ] items

The document request unique identifier. This parameter can be supplied multiple times.

document_idArray of strings, [ 0 .. 100 ] items

Document identifiers. This parameter can be supplied multiple times.

document_formatArray of strings, [ 0 .. 100 ] items

Document formats. This parameter can be supplied multiple times.

Items Enum:"PDF""cXML"

entity_idArray of strings, [ 0 .. 100 ] items

Entity identifiers related to the documents to download. This parameter can be supplied multiple times.
The entity_type must be specified to use this filter, otherwise an error 400 will be returned.
Example: entity_id=order1-A&entity_id=order20-A&entity_type=PRODUCT_LOGISTIC_ORDER

entity_typeArray of strings, [ 0 .. 100 ] items

Entity types related to the documents to download. This parameter can be supplied multiple times.

Items Enum:"PRODUCT_LOGISTIC_ORDER""SHOP_BILLING_CYCLE_PURCHASE_ORDER""LOGISTIC_PURCHASE_ORDER""FEES""ONE_OFF_FEES"

shop_idinteger, (int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/document-request/documents/download?document_request_id=string&document_id=string&document_format=PDF&entity_id=string&entity_type=PRODUCT_LOGISTIC_ORDER&shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/octet-stream

string, (binary)

Response

string