# Get a cursor paged list of consolidated orders

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.

Endpoint: GET /consolidated-orders
Version: 1.6.1
Security: clientCredentials

## Query parameters:

  - `plannability` (string, required)
    Enum: "UNPLANNABLE"

  - `cursor` (string)
    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.

  - `limit` (integer)
    Number of results per page.

## Response 200 fields (application/json):

  - `data` (array, required)

  - `data.order_id` (string)
    The unique identifier of an order

  - `data.transport_request_id` (string)
    The identifier of the _(optional)_ transport request related to the order

  - `data.order_type` (string)
    The type of the Order.
    Enum: "PICKUP", "DELIVERY", "PICKUP_DELIVERY"

  - `data.unplannable_reasons` (array)

  - `data.unplannable_reasons.reason` (string)
    A code indicating why an order is inherently unplannable. We keep these codes stable, so they can be used by automated integrations.  
Possible values:
- NO_PLANNABLE_TIME_WINDOWS_FOR_PICKUP
- NO_PLANNABLE_TIME_WINDOWS_FOR_DELIVERY

  - `data.unplannable_reasons.description` (string)
    Human-friendly description of the cause for the unplannability.

  - `cursor` (object, required)

  - `cursor.self` (string)
    The cursor for this page. Not present when the result contains no data.
    Example: "c2VsZl9fcGFnZQ"

  - `cursor.prev` (string)
    The cursor for the previous page. Not present when fetching data for the first page.
    Example: "cHJldmlvdXNfX3BhZ2U"

  - `cursor.next` (string)
    The cursor for the next page. Not present when fetching data for the last page.
    Example: "bmV4dF9fcGFnZQ"

## Response default fields (application/problem+json):

  - `type` (string)
    An absolute URI that identifies the problem type.  When dereferenced,
it SHOULD provide human-readable documentation for the problem type
(e.g., using HTML).
    Example: "https://api.conundra.eu/problem/constraint-violation"

  - `title` (string)
    A short, summary of the problem type. Written in english and readable
for engineers (usually not suited for non technical stakeholders and
not localized); example: Service Unavailable
    Example: "Invalid ..."

  - `status` (integer)
    The HTTP status code generated by the origin server for this occurrence
of the problem.
    Example: 400

  - `detail` (string)
    A human readable explanation specific to this occurrence of the
problem.
    Example: "string"

  - `instance` (string)
    An absolute URI that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.
    Example: "https://api.conundra.eu/orderbook/v1/orders/deliveries/chilled"

  - `violations` (array)

  - `violations.field` (string)
    A reference to the field in the request that triggered this violation.
    Example: "class.field"

  - `violations.message` (string)
    A message explaining the violation in the referenced field.
    Example: "a violation message"