List shop's documents

Mirakl Platform for Services APIs (latest-release)

Servers

URL to be replaced by your Mirakl instance URL

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

Platform Settings

Operations

Invoicing and Accounting

Operations

Stores

Operations

List shop's documents

Request

You must specify at least one of the following parameters: shop_ids, updated_since

Query

shop_idsstring

A list of shop identifiers

include_deletedboolean

True to include deleted documents, false to remove them

Default false

updated_sincestring(date-time)

Retrieve shop documents modified at or after this date. The time period cannot exceed 90 days

curl -i -X GET \
  'https://your-instance.mirakl.net/api/shops/documents?include_deleted=false&shop_ids=string&updated_since=2019-08-24T14%3A15%3A22Z'

Responses

Bodyapplication/json

shop_documentsArray of objects(S30_Response_200_ShopDocuments)

The document details

Response

application/json

{
  "shop_documents": [
    { … }
  ]
}

Download documents for one or multiple shops

Request

It is mandatory to specify either the shop_ids or the document_ids.
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 shop identifiers is specified, all documents from those shops are downloaded.
Use a list of shop document type codes to retrieve specific types from those shops.
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
|
|__ shop_id_x/
|   |__ foo.txt
|   |__ bar.txt
|   |__ baz.pdf
|
|__ shop_id_y/
|   |__ image.png
|   |__ image(1).png

Returns a 404 if at least one document id, one shop id or one document type code is invalid

Query

shop_idsstring

A list of shop identifiers (separated by a comma). It is mandatory to specify either the shop_ids or the document_ids

document_idsstring

A list of document identifiers (separated by a comma). It is mandatory to specify either the shop_ids or the document_ids

type_codesstring

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

curl -i -X GET \
  'https://your-instance.mirakl.net/api/shops/documents/download?document_ids=string&shop_ids=string&type_codes=string'

Responses

Bodyapplication/octet-stream

string(binary)

Delete a shop document

Request

Path

document_idinteger(int64)required

Document identifier to delete

curl -i -X DELETE \
  'https://your-instance.mirakl.net/api/shops/documents/{document_id}'

Responses

No Content

Services

Operations

Orders

Operations