Download one or multiple documents attached to one or multiple orders

Mirakl Marketplace APIs (latest-release)

Servers

URL to be replaced by your Mirakl instance URL

https://your-instance.mirakl.net/

Stores

Operations

Platform Settings

Operations

Invoicing and Accounting

Operations

Products

Operations

Messages

Operations

Offers

Operations

Orders

Operations

Lists order's documents

Request

Returns a list of all the documents available on the order

Query

order_idsstring<= 100

the orders' identifiers, using comma as separator

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/orders/documents?order_ids=string&shop_id=0'

Responses

Bodyapplication/json

order_documentsArray of objects(OR72_Response_200_OrderDocuments)

The document details

Response

application/json

{
  "order_documents": [
    { … }
  ]
}

Download one or multiple documents attached to one or multiple orders

Request

If a list of document identifiers is specified only these documents are downloaded.
- If more than one document id is specified, the documents will be wrapped in a ZIP archive
- If only one document id is specified the document will not be zipped
If a list of order identifiers is specified, all documents from those orders are downloaded.
Use a list of order document type codes to retrieve specific types from those orders.
In this case, the output of the API will always be a ZIP archive even if there is only one document to retrieve.

When documents are retrieved, they're wrapped into a ZIP archive except when only one document id is specified. The tree structure of this archive is as follow:


documents-timestamp.zip
|
|__ order_id_x/
|   |__ foo.txt
|   |__ bar.txt
|   |__ baz.pdf
|
|__ order_id_y/
|   |__ image.png
|   |__ image(1).png

Query

order_idsstring<= 100

A list of identifiers of the orders (separated by a comma)

document_idsstring<= 100

A list of document identifiers (separated by a comma)

document_codesstring<= 100

A list of document type codes (separated by a comma)

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/orders/documents/download?document_codes=string&document_ids=string&order_ids=string&shop_id=0'

Responses

Bodyapplication/octet-stream

string(binary)

List all the order taxes available on the platform

Request

Query

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.

localestring

<ISO-639>_<ISO-3166> ("en_US") or <ISO-639> ("en") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/orders/taxes?locale=string&shop_id=0'

Responses

Bodyapplication/json

taxesArray of objects(OR75_Response_200_Taxes)

List of the order taxes

Response

application/json

{
  "taxes": [
    { … }
  ]
}

Incidents

Operations

Picklists

Operations

Promotions

Operations

Returns

Operations

Multiple shipments

Operations