DR12 - List lines of a document request

Request

Pagination

This resource supports seek pagination (see documentation)

Sort fields

sort field can have the following values:

dateCreated - Sort by creation date (asc by default)

Security

Shop-API-Key(Required scopes: ROLE_SHOP_ADMIN)

Path

document_request_idstringrequired

Document Request identifier

Query

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/document-request/{document_request_id}/lines?shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

dataArray of objectsrequired

Page of data

next_page_tokenstring

Token to access the next page. Absent if the current page is the last one.

previous_page_tokenstring

Token to access the previous page. Absent if the current page is the first one.

Response

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