Skip to content

OR72 - Lists order's documents

Request

Description

Returns a list of all the documents available on the order

Call Frequency
Maximum usage: At each document list page display
Security
Shop-API-Key(Required scopes: ROLE_SHOP_ADMINROLE_PARTNER_ORDER_DOCUMENT_READ)
Query
order_idsstring, <= 100required

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' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
order_documentsArray of objectsrequired

The document details

total_countinteger, (int32)deprecated

Total number of documents

Response
{ "order_documents": [ { … }, { … } ] }