Stores

S30 - List shop's documents

Request

Description

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

Call Frequency

Recommended usage: At each display of a page that includes documents from a store (for example: during the KYC process)

Maximum usage: At each display of a page that includes documents from a store (for example: during the KYC process)

Security

Front-Bearer-Token or OAuth-2

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?shop_ids=string&include_deleted=false&updated_since=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json

shop_documentsArray of objectsrequired

The document details

total_countinteger, (int32)deprecated

Total number of documents

Response

{
  "shop_documents": [
    { … },
    { … }
  ],
  "total_count": 2
}