Get a cursor paged list of consolidated orders

Request

This endpoint allows you to retrieve a cursor paged list of information on consolidated orders, based on their plannability. We currently only support returning information on Orders that have become unplannable after consolidating the orders' timeframes with their Location and applicable Conditionals.

You can find out more about how to use cursors in our developer portal.

Security

clientCredentials

Query

plannabilitystringrequired

Value:"UNPLANNABLE"

cursorstring

Cursor of the page to retrieve. Can be left blank initially to retrieve the first page. Paging through the results requires passing in the cursor from a previous response.

limitinteger, (int32), [ 1 .. 1000 ]

Number of results per page.

Default:100

curl -i -X GET \
  'https://developer.conundra.eu/_mock/apis/order-book/order-book-api/consolidated-orders?plannability=UNPLANNABLE&cursor=string&limit=100' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json

dataArray of objects, [ 0 .. 100 ] items, unique(Consolidated Order)required

cursorobject(Cursor)required

Response

{
  "data": [
    { … }
  ],
  "cursor": {
    "self": "c2VsZl9fcGFnZQ",
    "prev": "cHJldmlvdXNfX3BhZ2U",
    "next": "bmV4dF9fcGFnZQ"
  }
}