DO01 - List all document types

Request

Call Frequency

Recommended usage: Once per day

Maximum usage: Once per day

Localization

This resource supports locale parameter (see documentation)

Localized output fields will be highlighted with an icon:

Security

Shop-API-Key(Required scopes: ROLE_SHOP_ADMINROLE_PARTNER_ORDER_SETTINGS_READ)

Query

entitiesstring

A comma separated list of values, representing the type of entities the document type should be related to. Accepted values are ORDER, SHOP. Ex: ORDER,SHOP

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

Responses

OK

Bodyapplication/json

documentsArray of objectsrequired

Document types

Response

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