S30 - List shop's documents

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

Shop-API-Key(Required scopes: ROLE_SHOP_ADMINROLE_PARTNER_SHOP_DOCUMENT_READ)

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/shops/documents?shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

OK

Bodyapplication/json

shop_documentsArray of objectsrequired

Document details

total_countinteger, (int32)deprecated

Total number of documents

Response

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