---
metadata:
  - name: generator
    content: Diplodoc Platform v5.63.0
alternate:
  - https://fleet.yandex.ru/docs/api/en/openapi/Orders/v2parksorderslist-post.md
  - https://fleet.yandex.ru/docs/api/ru/openapi/Orders/v2parksorderslist-post.md
  - href: https://fleet.yandex.ru/docs/api/en/openapi/Orders/v2parksorderslist-post.md
    type: text/markdown
    title: Markdown version
  - href: https://fleet.yandex.ru/docs/api/en/llms.txt?revision=r21515713
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://fleet.yandex.ru/docs/api/en/llms.txt?revision=r21515713

<div class="openapi">

#  Getting list of orders v2 

<!-- markdownlint-disable-file -->

 Returns a list of park orders with the same filters and pagination as v1. For parks with the Eats specification and contractors with the Eats courier profession, orders may include the Eats courier ID, city, and transport type. Eats fields are optional: missing profiles or values result in omitted fields. If enrichment data is unavailable, the base order list is returned without Eats fields. The mileage field is passed through unchanged, as in v1. 

## Request

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-post);margin-bottom: 12px">

<div class="openapi__request">

POST {.openapi__method}
```text translate=no
https://fleet-api.taxi.yandex.net/v2/parks/orders/list
```

</div>

</div>

</div>

### Headers

#|
|| **Name** | **Description** ||
||

_X-API-Key_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

 API-key 

_Min length:_{.json-schema-reset .json-schema-assertion} `1`

_Example:_{.json-schema-reset .json-schema-example} `<API key>`
{.table-cell}
||
||

_X-Client-ID_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

 Client ID 

_Min length:_{.json-schema-reset .json-schema-assertion} `1`

_Example:_{.json-schema-reset .json-schema-example} `<Client ID>`
{.table-cell}
||
|#{.json-schema-properties}

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "query": {
    "park": {
      "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
      "order": {
        "ids": [
          "c8d40acf182b4b32af72f6ad2029031b"
        ],
        "short_ids": [
          248
        ],
        "booked_at": {
          "from": "2019-08-08T11:58:01+03:00",
          "to": null
        },
        "ended_at": null,
        "type": {
          "ids": [
            null
          ]
        },
        "statuses": [
          "complete"
        ],
        "payment_methods": [
          "card"
        ],
        "providers": [
          "platform"
        ],
        "categories": [
          "econom"
        ],
        "price": {
          "from": "12345.1434",
          "to": null
        }
      },
      "driver_profile": {
        "id": "33de650c6a1a40bfa78dd981817da866"
      },
      "car": {
        "id": "5011ade6ba054dfdb7143c8cc9460dbc"
      }
    }
  },
  "limit": 100,
  "cursor": "example"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_limit_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [OrdersListLimit](#entity-OrdersListLimit)

 Upper limit of the number of orders per response 

_Min value:_{.json-schema-reset .json-schema-assertion} `1`

_Max value:_{.json-schema-reset .json-schema-assertion} `500`

_Example:_{.json-schema-reset .json-schema-example} `100`
{.table-cell}
||
||

_query_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [OrdersListQuery](#entity-OrdersListQuery)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "park": {
    "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
    "order": {
      "ids": [
        "c8d40acf182b4b32af72f6ad2029031b"
      ],
      "short_ids": [
        248
      ],
      "booked_at": {
        "from": "2019-08-08T11:58:01+03:00",
        "to": null
      },
      "ended_at": null,
      "type": {
        "ids": [
          "4964b852670045b196e526d59915b777"
        ]
      },
      "statuses": [
        "complete"
      ],
      "payment_methods": [
        "card"
      ],
      "providers": [
        "platform"
      ],
      "categories": [
        "econom"
      ],
      "price": {
        "from": "12345.1434",
        "to": null
      }
    },
    "driver_profile": {
      "id": "33de650c6a1a40bfa78dd981817da866"
    },
    "car": {
      "id": "5011ade6ba054dfdb7143c8cc9460dbc"
    }
  }
}
```

{% endcut %}
{.table-cell}
||
||

_cursor_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [RequestCursor](#entity-RequestCursor)

 Cursor for obtaining the next data chunk, the value must be taken from the response to the previous request 

_Min length:_{.json-schema-reset .json-schema-assertion} `1`

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### ParkId {#entity-ParkId}

 Partner ID 

**Type**: string

_Min length:_{.json-schema-reset .json-schema-assertion} `1`

_Max length:_{.json-schema-reset .json-schema-assertion} `100`

_Example:_{.json-schema-reset .json-schema-example} `ee6f33c4562b4e1f8646d157bd70b2c4`

</div>

<div class="openapi-entity">

### OrderId {#entity-OrderId}

 Order ID 

**Type**: string

_Min length:_{.json-schema-reset .json-schema-assertion} `1`

_Max length:_{.json-schema-reset .json-schema-assertion} `100`

_Example:_{.json-schema-reset .json-schema-example} `c8d40acf182b4b32af72f6ad2029031b`

</div>

<div class="openapi-entity">

### OrderIds {#entity-OrderIds}

**Type**: [OrderId](#entity-OrderId)[]

_Min items:_{.json-schema-reset .json-schema-assertion} `1`

_Max items:_{.json-schema-reset .json-schema-assertion} `100`

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "c8d40acf182b4b32af72f6ad2029031b"
]
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrderShortId {#entity-OrderShortId}

 Index number of the order (with canceled orders taken into account) 

**Type**: integer

_Min value:_{.json-schema-reset .json-schema-assertion} `0`

</div>

<div class="openapi-entity">

### OrderShortIds {#entity-OrderShortIds}

**Type**: [OrderShortId](#entity-OrderShortId)[]

_Min items:_{.json-schema-reset .json-schema-assertion} `1`

_Max items:_{.json-schema-reset .json-schema-assertion} `100`

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  248
]
```

{% endcut %}

</div>

<div class="openapi-entity">

### DateTime {#entity-DateTime}

 ISO 8601 with time zone 

**Type**: string&lt;date-time&gt;

_Example:_{.json-schema-reset .json-schema-example} `2019-08-08T11:58:01+03:00`

</div>

<div class="openapi-entity">

### DateTimeInterval {#entity-DateTimeInterval}

#|
|| **Name** | **Description** ||
||

_from_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [DateTime](#entity-DateTime)

 ISO 8601 with time zone 

_Example:_{.json-schema-reset .json-schema-example} `2019-08-08T11:58:01+03:00`
{.table-cell}
||
||

_to_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [DateTime](#entity-DateTime)

 ISO 8601 with time zone 

_Example:_{.json-schema-reset .json-schema-example} `2019-08-08T11:58:01+03:00`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "from": "2019-08-08T11:58:01+03:00",
  "to": null
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrderTypeId {#entity-OrderTypeId}

 Order type ID 

**Type**: string

_Min length:_{.json-schema-reset .json-schema-assertion} `1`

_Example:_{.json-schema-reset .json-schema-example} `4964b852670045b196e526d59915b777`

</div>

<div class="openapi-entity">

### OrderTypeIds {#entity-OrderTypeIds}

**Type**: [OrderTypeId](#entity-OrderTypeId)[]

_Min items:_{.json-schema-reset .json-schema-assertion} `1`

_Max items:_{.json-schema-reset .json-schema-assertion} `100`

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "4964b852670045b196e526d59915b777"
]
```

{% endcut %}

</div>

<div class="openapi-entity">

### QueryParkOrderType {#entity-QueryParkOrderType}

#|
|| **Name** | **Description** ||
||

_ids_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [OrderTypeIds](#entity-OrderTypeIds)

_Min items:_{.json-schema-reset .json-schema-assertion} `1`

_Max items:_{.json-schema-reset .json-schema-assertion} `100`

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "4964b852670045b196e526d59915b777"
]
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "ids": [
    "4964b852670045b196e526d59915b777"
  ]
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrderStatus {#entity-OrderStatus}

 Order status. Possible values:
* `none` — no status;
* `driving` — en route;
* `waiting` — is waiting for the client;
* `transporting` — is on the ride now;
* `complete` — order completed;
* `cancelled` — cancelled;
* `calling` — status for a technical error;
* `expired` — status for a technical error;
* `failed` — status for a technical error; 

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `none`, `driving`, `waiting`, `transporting`, `complete`, `cancelled`, `calling`, `expired`, `failed`

</div>

<div class="openapi-entity">

### Statuses {#entity-Statuses}

**Type**: [OrderStatus](#entity-OrderStatus)[]

_Min items:_{.json-schema-reset .json-schema-assertion} `1`

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "complete"
]
```

{% endcut %}

</div>

<div class="openapi-entity">

### PaymentMethod {#entity-PaymentMethod}

 Payment method. Possible values:
* `cash` — cash;
* `cashless` — non-cash;
* `card` — card;
* `internal` — internal;
* `other` — other;
* `corp` — corporate account;
* `prepaid` — advance payment. 

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `cash`, `cashless`, `card`, `internal`, `other`, `corp`, `prepaid`

</div>

<div class="openapi-entity">

### PaymentMethods {#entity-PaymentMethods}

**Type**: [PaymentMethod](#entity-PaymentMethod)[]

_Min items:_{.json-schema-reset .json-schema-assertion} `1`

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "card"
]
```

{% endcut %}

</div>

<div class="openapi-entity">

### Provider {#entity-Provider}

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `none`, `partner`, `platform`

</div>

<div class="openapi-entity">

### Providers {#entity-Providers}

**Type**: [Provider](#entity-Provider)[]

_Min items:_{.json-schema-reset .json-schema-assertion} `1`

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "platform"
]
```

{% endcut %}

</div>

<div class="openapi-entity">

### Categories {#entity-Categories}

 List of vehicle categories. Possible values:
* `econom` — Economy class;
* `comfort` — Comfort;
* `comfort_plus` — Comfort+;
* `business` — business class vehicle;
* `minivan` — minivan;
* `vip` — A VIP class vehicle;
* `wagon` — multi-purpose;
* `pool` — pool class vehicle;
* `start` — Start class vehicle;
* `standart` — Standart class vehicle;
* `ultimate` — Premier;
* `maybach` — elite class vehicle;
* `promo` — promotion;
* `premium_van` — cruise van;
* `premium_suv` — premium SUV;
* `suv` — SUV;
* `personal_driver` — personal driver class vehicle;
* `express` — delivery class vehicle;
* `cargo` — a cargo vehicle. 

**Type**: string[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "econom"
]
```

{% endcut %}

</div>

<div class="openapi-entity">

### Amount {#entity-Amount}

 Fixed-point sum 

**Type**: string

_Max length:_{.json-schema-reset .json-schema-assertion} `20`

_Example:_{.json-schema-reset .json-schema-example} `12345.1434`

</div>

<div class="openapi-entity">

### PriceInterval {#entity-PriceInterval}

#|
|| **Name** | **Description** ||
||

_from_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Amount](#entity-Amount)

 Fixed-point sum 

_Max length:_{.json-schema-reset .json-schema-assertion} `20`

_Example:_{.json-schema-reset .json-schema-example} `12345.1434`
{.table-cell}
||
||

_to_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Amount](#entity-Amount)

 Fixed-point sum 

_Max length:_{.json-schema-reset .json-schema-assertion} `20`

_Example:_{.json-schema-reset .json-schema-example} `12345.1434`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "from": "12345.1434",
  "to": null
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersListQueryParkOrder {#entity-OrdersListQueryParkOrder}

 Either booked_at or ended_at is required 

#|
|| **Name** | **Description** ||
||

_booked_at_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DateTimeInterval](#entity-DateTimeInterval)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "from": "2019-08-08T11:58:01+03:00",
  "to": null
}
```

{% endcut %}
{.table-cell}
||
||

_categories_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Categories](#entity-Categories)

 List of vehicle categories. Possible values:
* `econom` — Economy class;
* `comfort` — Comfort;
* `comfort_plus` — Comfort+;
* `business` — business class vehicle;
* `minivan` — minivan;
* `vip` — A VIP class vehicle;
* `wagon` — multi-purpose;
* `pool` — pool class vehicle;
* `start` — Start class vehicle;
* `standart` — Standart class vehicle;
* `ultimate` — Premier;
* `maybach` — elite class vehicle;
* `promo` — promotion;
* `premium_van` — cruise van;
* `premium_suv` — premium SUV;
* `suv` — SUV;
* `personal_driver` — personal driver class vehicle;
* `express` — delivery class vehicle;
* `cargo` — a cargo vehicle. 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "econom"
]
```

{% endcut %}
{.table-cell}
||
||

_ended_at_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DateTimeInterval](#entity-DateTimeInterval)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "from": "2019-08-08T11:58:01+03:00",
  "to": null
}
```

{% endcut %}
{.table-cell}
||
||

_ids_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [OrderIds](#entity-OrderIds)

_Min items:_{.json-schema-reset .json-schema-assertion} `1`

_Max items:_{.json-schema-reset .json-schema-assertion} `100`

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "c8d40acf182b4b32af72f6ad2029031b"
]
```

{% endcut %}
{.table-cell}
||
||

_payment_methods_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [PaymentMethods](#entity-PaymentMethods)

_Min items:_{.json-schema-reset .json-schema-assertion} `1`

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "card"
]
```

{% endcut %}
{.table-cell}
||
||

_price_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [PriceInterval](#entity-PriceInterval)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "from": "12345.1434",
  "to": null
}
```

{% endcut %}
{.table-cell}
||
||

_providers_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Providers](#entity-Providers)

_Min items:_{.json-schema-reset .json-schema-assertion} `1`

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "platform"
]
```

{% endcut %}
{.table-cell}
||
||

_short_ids_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [OrderShortIds](#entity-OrderShortIds)

_Min items:_{.json-schema-reset .json-schema-assertion} `1`

_Max items:_{.json-schema-reset .json-schema-assertion} `100`

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  248
]
```

{% endcut %}
{.table-cell}
||
||

_statuses_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Statuses](#entity-Statuses)

_Min items:_{.json-schema-reset .json-schema-assertion} `1`

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "complete"
]
```

{% endcut %}
{.table-cell}
||
||

_type_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [QueryParkOrderType](#entity-QueryParkOrderType)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "ids": [
    "4964b852670045b196e526d59915b777"
  ]
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "ids": [
    "c8d40acf182b4b32af72f6ad2029031b"
  ],
  "short_ids": [
    248
  ],
  "booked_at": {
    "from": "2019-08-08T11:58:01+03:00",
    "to": null
  },
  "ended_at": null,
  "type": {
    "ids": [
      "4964b852670045b196e526d59915b777"
    ]
  },
  "statuses": [
    "complete"
  ],
  "payment_methods": [
    "card"
  ],
  "providers": [
    "platform"
  ],
  "categories": [
    "econom"
  ],
  "price": {
    "from": "12345.1434",
    "to": null
  }
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### DriverProfileId {#entity-DriverProfileId}

 Driver ID 

**Type**: string

_Min length:_{.json-schema-reset .json-schema-assertion} `1`

_Max length:_{.json-schema-reset .json-schema-assertion} `100`

_Example:_{.json-schema-reset .json-schema-example} `33de650c6a1a40bfa78dd981817da866`

</div>

<div class="openapi-entity">

### OrdersListQueryParkDriverProfile {#entity-OrdersListQueryParkDriverProfile}

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [DriverProfileId](#entity-DriverProfileId)

 Driver ID 

_Min length:_{.json-schema-reset .json-schema-assertion} `1`

_Max length:_{.json-schema-reset .json-schema-assertion} `100`

_Example:_{.json-schema-reset .json-schema-example} `33de650c6a1a40bfa78dd981817da866`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "33de650c6a1a40bfa78dd981817da866"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### CarId {#entity-CarId}

 Vehicle ID 

**Type**: string

_Min length:_{.json-schema-reset .json-schema-assertion} `1`

_Max length:_{.json-schema-reset .json-schema-assertion} `100`

_Example:_{.json-schema-reset .json-schema-example} `5011ade6ba054dfdb7143c8cc9460dbc`

</div>

<div class="openapi-entity">

### OrdersListQueryParkCar {#entity-OrdersListQueryParkCar}

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [CarId](#entity-CarId)

 Vehicle ID 

_Min length:_{.json-schema-reset .json-schema-assertion} `1`

_Max length:_{.json-schema-reset .json-schema-assertion} `100`

_Example:_{.json-schema-reset .json-schema-example} `5011ade6ba054dfdb7143c8cc9460dbc`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "5011ade6ba054dfdb7143c8cc9460dbc"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersListQueryPark {#entity-OrdersListQueryPark}

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [ParkId](#entity-ParkId)

 Partner ID 

_Min length:_{.json-schema-reset .json-schema-assertion} `1`

_Max length:_{.json-schema-reset .json-schema-assertion} `100`

_Example:_{.json-schema-reset .json-schema-example} `ee6f33c4562b4e1f8646d157bd70b2c4`
{.table-cell}
||
||

_order_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [OrdersListQueryParkOrder](#entity-OrdersListQueryParkOrder)

 Either booked_at or ended_at is required 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "ids": [
    "c8d40acf182b4b32af72f6ad2029031b"
  ],
  "short_ids": [
    248
  ],
  "booked_at": {
    "from": "2019-08-08T11:58:01+03:00",
    "to": null
  },
  "ended_at": null,
  "type": {
    "ids": [
      "4964b852670045b196e526d59915b777"
    ]
  },
  "statuses": [
    "complete"
  ],
  "payment_methods": [
    "card"
  ],
  "providers": [
    "platform"
  ],
  "categories": [
    "econom"
  ],
  "price": {
    "from": "12345.1434",
    "to": null
  }
}
```

{% endcut %}
{.table-cell}
||
||

_car_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [OrdersListQueryParkCar](#entity-OrdersListQueryParkCar)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "5011ade6ba054dfdb7143c8cc9460dbc"
}
```

{% endcut %}
{.table-cell}
||
||

_driver_profile_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [OrdersListQueryParkDriverProfile](#entity-OrdersListQueryParkDriverProfile)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "33de650c6a1a40bfa78dd981817da866"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
  "order": {
    "ids": [
      "c8d40acf182b4b32af72f6ad2029031b"
    ],
    "short_ids": [
      248
    ],
    "booked_at": {
      "from": "2019-08-08T11:58:01+03:00",
      "to": null
    },
    "ended_at": null,
    "type": {
      "ids": [
        "4964b852670045b196e526d59915b777"
      ]
    },
    "statuses": [
      "complete"
    ],
    "payment_methods": [
      "card"
    ],
    "providers": [
      "platform"
    ],
    "categories": [
      "econom"
    ],
    "price": {
      "from": "12345.1434",
      "to": null
    }
  },
  "driver_profile": {
    "id": "33de650c6a1a40bfa78dd981817da866"
  },
  "car": {
    "id": "5011ade6ba054dfdb7143c8cc9460dbc"
  }
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersListQuery {#entity-OrdersListQuery}

#|
|| **Name** | **Description** ||
||

_park_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [OrdersListQueryPark](#entity-OrdersListQueryPark)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
  "order": {
    "ids": [
      "c8d40acf182b4b32af72f6ad2029031b"
    ],
    "short_ids": [
      248
    ],
    "booked_at": {
      "from": "2019-08-08T11:58:01+03:00",
      "to": null
    },
    "ended_at": null,
    "type": {
      "ids": [
        "4964b852670045b196e526d59915b777"
      ]
    },
    "statuses": [
      "complete"
    ],
    "payment_methods": [
      "card"
    ],
    "providers": [
      "platform"
    ],
    "categories": [
      "econom"
    ],
    "price": {
      "from": "12345.1434",
      "to": null
    }
  },
  "driver_profile": {
    "id": "33de650c6a1a40bfa78dd981817da866"
  },
  "car": {
    "id": "5011ade6ba054dfdb7143c8cc9460dbc"
  }
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "park": {
    "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
    "order": {
      "ids": [
        "c8d40acf182b4b32af72f6ad2029031b"
      ],
      "short_ids": [
        248
      ],
      "booked_at": {
        "from": "2019-08-08T11:58:01+03:00",
        "to": null
      },
      "ended_at": null,
      "type": {
        "ids": [
          "4964b852670045b196e526d59915b777"
        ]
      },
      "statuses": [
        "complete"
      ],
      "payment_methods": [
        "card"
      ],
      "providers": [
        "platform"
      ],
      "categories": [
        "econom"
      ],
      "price": {
        "from": "12345.1434",
        "to": null
      }
    },
    "driver_profile": {
      "id": "33de650c6a1a40bfa78dd981817da866"
    },
    "car": {
      "id": "5011ade6ba054dfdb7143c8cc9460dbc"
    }
  }
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersListLimit {#entity-OrdersListLimit}

 Upper limit of the number of orders per response 

**Type**: integer

_Min value:_{.json-schema-reset .json-schema-assertion} `1`

_Max value:_{.json-schema-reset .json-schema-assertion} `500`

</div>

<div class="openapi-entity">

### RequestCursor {#entity-RequestCursor}

 Cursor for obtaining the next data chunk, the value must be taken from the response to the previous request 

**Type**: string

_Min length:_{.json-schema-reset .json-schema-assertion} `1`

_Example:_{.json-schema-reset .json-schema-example} `example`

</div>

## Responses

<div class="openapi__response__code__200">

## 200 OK

 List of orders 

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "orders": [
    {
      "id": "c8d40acf182b4b32af72f6ad2029031b",
      "short_id": 248,
      "status": "complete",
      "created_at": "2019-08-08T11:58:01+03:00",
      "booked_at": null,
      "provider": "platform",
      "category": "econom",
      "amenities": [
        "wifi"
      ],
      "address_from": {
        "address": "8 Liberty Street",
        "lat": 55.762235,
        "lon": 37.609651
      },
      "route_points": [
        null
      ],
      "events": [
        {
          "event_at": null,
          "order_status": null
        }
      ],
      "ended_at": null,
      "payment_method": "card",
      "driver_profile": {
        "id": "33de650c6a1a40bfa78dd981817da866",
        "name": "Smith, John Richard"
      },
      "car": {
        "id": "5011ade6ba054dfdb7143c8cc9460dbc",
        "brand_model": "BMW 5er",
        "license": {
          "number": "AA01234567"
        },
        "callsign": "123456789"
      },
      "type": {
        "id": "4964b852670045b196e526d59915b777",
        "name": "Yandex.Cashless"
      },
      "price": "12345.1434",
      "driver_work_rule": {
        "id": "e26a3cf21acfe01198d50030487e046b",
        "name": "Rental"
      },
      "mileage": "example",
      "cancellation_description": "example",
      "park_details": {
        "tariff": {
          "id": "example",
          "name": "example"
        },
        "passenger": {
          "name": "example",
          "phones": [
            null
          ]
        },
        "company": {
          "id": "example",
          "name": "example",
          "slip": "example",
          "comment": "example"
        }
      },
      "order_time_interval": {
        "from": null,
        "to": null
      },
      "driving_at": null,
      "flags": [
        "example"
      ],
      "eats_courier_id": "123456",
      "eats_courier_city": "Москва",
      "eats_courier_type": "bicycle"
    }
  ],
  "limit": 100,
  "cursor": ""
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_limit_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [OrdersListLimit](#entity-OrdersListLimit)

 Upper limit of the number of orders per response 

_Min value:_{.json-schema-reset .json-schema-assertion} `1`

_Max value:_{.json-schema-reset .json-schema-assertion} `500`

_Example:_{.json-schema-reset .json-schema-example} `100`
{.table-cell}
||
||

_orders_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [OrdersListV2](#entity-OrdersListV2)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "id": "c8d40acf182b4b32af72f6ad2029031b",
    "short_id": 248,
    "status": "complete",
    "created_at": "2019-08-08T11:58:01+03:00",
    "booked_at": null,
    "provider": "platform",
    "category": "econom",
    "amenities": [
      "wifi"
    ],
    "address_from": {
      "address": "8 Liberty Street",
      "lat": 55.762235,
      "lon": 37.609651
    },
    "route_points": [
      null
    ],
    "events": [
      {
        "event_at": null,
        "order_status": null
      }
    ],
    "ended_at": null,
    "payment_method": "card",
    "driver_profile": {
      "id": "33de650c6a1a40bfa78dd981817da866",
      "name": "Smith, John Richard"
    },
    "car": {
      "id": "5011ade6ba054dfdb7143c8cc9460dbc",
      "brand_model": "BMW 5er",
      "license": {
        "number": "AA01234567"
      },
      "callsign": "123456789"
    },
    "type": {
      "id": "4964b852670045b196e526d59915b777",
      "name": "Yandex.Cashless"
    },
    "price": "12345.1434",
    "driver_work_rule": {
      "id": "e26a3cf21acfe01198d50030487e046b",
      "name": "Rental"
    },
    "mileage": "example",
    "cancellation_description": "example",
    "park_details": {
      "tariff": {
        "id": "example",
        "name": "example"
      },
      "passenger": {
        "name": "example",
        "phones": [
          "example"
        ]
      },
      "company": {
        "id": "example",
        "name": "example",
        "slip": "example",
        "comment": "example"
      }
    },
    "order_time_interval": {
      "from": null,
      "to": null
    },
    "driving_at": null,
    "flags": [
      "example"
    ],
    "eats_courier_id": "123456",
    "eats_courier_city": "Москва",
    "eats_courier_type": "bicycle"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_cursor_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [ResponseCursor](#entity-ResponseCursor)

 Cursor for obtaining the next data chunk 

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### Category {#entity-Category}

 Vehicle category. Possible values:
* `econom` — Economy class;
* `comfort` — Comfort;
* `comfort_plus` — Comfort+;
* `business` — business class vehicle;
* `minivan` — minivan;
* `vip` — A VIP class vehicle;
* `wagon` — multi-purpose;
* `pool` — pool class vehicle;
* `start` — Start class vehicle;
* `standart` — Standart class vehicle;
* `child_tariff` — Kids service class;
* `ultimate` — Premier;
* `maybach` — elite class vehicle;
* `promo` — promotion;
* `premium_van` — cruise van;
* `premium_suv` — premium SUV;
* `suv` — SUV;
* `personal_driver` — personal driver class vehicle;
* `express` — delivery class vehicle;
* `cargo` — a cargo vehicle. 

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `econom`, `comfort`, `comfort_plus`, `business`, `minivan`, `vip`, `wagon`, `pool`, `start`, `standart`, `child_tariff`, `ultimate`, `maybach`, `promo`, `premium_van`, `premium_suv`, `suv`, `personal_driver`, `express`, `cargo`

</div>

<div class="openapi-entity">

### Amenities {#entity-Amenities}

 Vehilce amenity. Possible values:
* `conditioner`
* `no_smoking`
* `child_chair`
* `animal_transport`
* `universal`
* `wifi`
* `check`
* `card`
* `yamoney`
* `newspaper`
* `coupon`
* `creditcard`
* `dont_call`
* `smoking`
* `delivery`
* `vip_event`
* `woman_driver`
* `post_terminal`
* `bicycle`
* `skiing`
* `passenger_plus`
* `cargo_clean`
* `door_to_door`
* `sticker`
* `lightbox` 

**Type**: string[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "wifi"
]
```

{% endcut %}

</div>

<div class="openapi-entity">

### AddressInfo {#entity-AddressInfo}

#|
|| **Name** | **Description** ||
||

_address_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

 Order address 

_Example:_{.json-schema-reset .json-schema-example} `8 Liberty Street`
{.table-cell}
||
||

_lat_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: number

 Geographic latitude 
{.table-cell}
||
||

_lon_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: number

 Geographic longitude 
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "address": "8 Liberty Street",
  "lat": 55.762235,
  "lon": 37.609651
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### RoutePoints {#entity-RoutePoints}

**Type**: [AddressInfo](#entity-AddressInfo)[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "address": "8 Liberty Street",
    "lat": 55.762235,
    "lon": 37.609651
  }
]
```

{% endcut %}

</div>

<div class="openapi-entity">

### Event {#entity-Event}

#|
|| **Name** | **Description** ||
||

_event_at_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [DateTime](#entity-DateTime)

 ISO 8601 with time zone 

_Example:_{.json-schema-reset .json-schema-example} `2019-08-08T11:58:01+03:00`
{.table-cell}
||
||

_order_status_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [OrderStatus](#entity-OrderStatus)

 Order status. Possible values:
* `none` — no status;
* `driving` — en route;
* `waiting` — is waiting for the client;
* `transporting` — is on the ride now;
* `complete` — order completed;
* `cancelled` — cancelled;
* `calling` — status for a technical error;
* `expired` — status for a technical error;
* `failed` — status for a technical error; 

_Enum:_{.json-schema-reset .json-schema-value} `none`, `driving`, `waiting`, `transporting`, `complete`, `cancelled`, `calling`, `expired`, `failed`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "event_at": "2019-08-08T11:58:01+03:00",
  "order_status": "complete"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### Events {#entity-Events}

**Type**: [Event](#entity-Event)[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "event_at": "2019-08-08T11:58:01+03:00",
    "order_status": "complete"
  }
]
```

{% endcut %}

</div>

<div class="openapi-entity">

### DriverProfile {#entity-DriverProfile}

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DriverProfileId](#entity-DriverProfileId)

 Driver ID 

_Min length:_{.json-schema-reset .json-schema-assertion} `1`

_Max length:_{.json-schema-reset .json-schema-assertion} `100`

_Example:_{.json-schema-reset .json-schema-example} `33de650c6a1a40bfa78dd981817da866`
{.table-cell}
||
||

_name_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

 Driver's full name 

_Example:_{.json-schema-reset .json-schema-example} `Smith, John Richard`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "33de650c6a1a40bfa78dd981817da866",
  "name": "Smith, John Richard"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### License {#entity-License}

#|
|| **Name** | **Description** ||
||

_number_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

 Vehicle registration number 

_Example:_{.json-schema-reset .json-schema-example} `AA01234567`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "number": "AA01234567"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### Callsign {#entity-Callsign}

 Vehicle code name (short name) 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `123456789`

</div>

<div class="openapi-entity">

### OrdersListCar {#entity-OrdersListCar}

#|
|| **Name** | **Description** ||
||

_brand_model_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

 Vehicle make and model 

_Example:_{.json-schema-reset .json-schema-example} `BMW 5er`
{.table-cell}
||
||

_callsign_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Callsign](#entity-Callsign)

 Vehicle code name (short name) 

_Example:_{.json-schema-reset .json-schema-example} `123456789`
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [CarId](#entity-CarId)

 Vehicle ID 

_Min length:_{.json-schema-reset .json-schema-assertion} `1`

_Max length:_{.json-schema-reset .json-schema-assertion} `100`

_Example:_{.json-schema-reset .json-schema-example} `5011ade6ba054dfdb7143c8cc9460dbc`
{.table-cell}
||
||

_license_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [License](#entity-License)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "number": "AA01234567"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "5011ade6ba054dfdb7143c8cc9460dbc",
  "brand_model": "BMW 5er",
  "license": {
    "number": "AA01234567"
  },
  "callsign": "123456789"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrderType {#entity-OrderType}

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [OrderTypeId](#entity-OrderTypeId)

 Order type ID 

_Min length:_{.json-schema-reset .json-schema-assertion} `1`

_Example:_{.json-schema-reset .json-schema-example} `4964b852670045b196e526d59915b777`
{.table-cell}
||
||

_name_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

 Order type name 

_Example:_{.json-schema-reset .json-schema-example} `Yandex.Cashless`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "4964b852670045b196e526d59915b777",
  "name": "Yandex.Cashless"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### DriverWorkRule {#entity-DriverWorkRule}

 Driver's working condition 

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

 Working condition ID of the driver 

_Example:_{.json-schema-reset .json-schema-example} `e26a3cf21acfe01198d50030487e046b`
{.table-cell}
||
||

_name_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

 Working condition name of the driver 

_Example:_{.json-schema-reset .json-schema-example} `Rental`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "e26a3cf21acfe01198d50030487e046b",
  "name": "Rental"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrderTariff {#entity-OrderTariff}

 Taxi company's service classes 

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_name_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "example",
  "name": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### Passenger {#entity-Passenger}

#|
|| **Name** | **Description** ||
||

_name_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_phones_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string[]

_Min items:_{.json-schema-reset .json-schema-assertion} `1`

_Max items:_{.json-schema-reset .json-schema-assertion} `3`

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "example"
]
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "name": "example",
  "phones": [
    "example"
  ]
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### Company {#entity-Company}

#|
|| **Name** | **Description** ||
||

_comment_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_name_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_slip_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "example",
  "name": "example",
  "slip": "example",
  "comment": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### ParkDetails {#entity-ParkDetails}

#|
|| **Name** | **Description** ||
||

_company_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Company](#entity-Company)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "example",
  "name": "example",
  "slip": "example",
  "comment": "example"
}
```

{% endcut %}
{.table-cell}
||
||

_passenger_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Passenger](#entity-Passenger)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "name": "example",
  "phones": [
    "example"
  ]
}
```

{% endcut %}
{.table-cell}
||
||

_tariff_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [OrderTariff](#entity-OrderTariff)

 Taxi company's service classes 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "example",
  "name": "example"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "tariff": {
    "id": "example",
    "name": "example"
  },
  "passenger": {
    "name": "example",
    "phones": [
      "example"
    ]
  },
  "company": {
    "id": "example",
    "name": "example",
    "slip": "example",
    "comment": "example"
  }
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrderV2 {#entity-OrderV2}

#|
|| **Name** | **Description** ||
||

_address_from_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [AddressInfo](#entity-AddressInfo)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "address": "8 Liberty Street",
  "lat": 55.762235,
  "lon": 37.609651
}
```

{% endcut %}
{.table-cell}
||
||

_amenities_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [Amenities](#entity-Amenities)

 Vehilce amenity. Possible values:
* `conditioner`
* `no_smoking`
* `child_chair`
* `animal_transport`
* `universal`
* `wifi`
* `check`
* `card`
* `yamoney`
* `newspaper`
* `coupon`
* `creditcard`
* `dont_call`
* `smoking`
* `delivery`
* `vip_event`
* `woman_driver`
* `post_terminal`
* `bicycle`
* `skiing`
* `passenger_plus`
* `cargo_clean`
* `door_to_door`
* `sticker`
* `lightbox` 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "wifi"
]
```

{% endcut %}
{.table-cell}
||
||

_booked_at_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [DateTime](#entity-DateTime)

 ISO 8601 with time zone 

_Example:_{.json-schema-reset .json-schema-example} `2019-08-08T11:58:01+03:00`
{.table-cell}
||
||

_created_at_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [DateTime](#entity-DateTime)

 ISO 8601 with time zone 

_Example:_{.json-schema-reset .json-schema-example} `2019-08-08T11:58:01+03:00`
{.table-cell}
||
||

_events_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [Events](#entity-Events)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "event_at": "2019-08-08T11:58:01+03:00",
    "order_status": "complete"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [OrderId](#entity-OrderId)

 Order ID 

_Min length:_{.json-schema-reset .json-schema-assertion} `1`

_Max length:_{.json-schema-reset .json-schema-assertion} `100`

_Example:_{.json-schema-reset .json-schema-example} `c8d40acf182b4b32af72f6ad2029031b`
{.table-cell}
||
||

_provider_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [Provider](#entity-Provider)

_Enum:_{.json-schema-reset .json-schema-value} `none`, `partner`, `platform`
{.table-cell}
||
||

_route_points_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [RoutePoints](#entity-RoutePoints)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "address": "8 Liberty Street",
    "lat": 55.762235,
    "lon": 37.609651
  }
]
```

{% endcut %}
{.table-cell}
||
||

_short_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [OrderShortId](#entity-OrderShortId)

 Index number of the order (with canceled orders taken into account) 

_Min value:_{.json-schema-reset .json-schema-assertion} `0`

_Example:_{.json-schema-reset .json-schema-example} `248`
{.table-cell}
||
||

_status_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [OrderStatus](#entity-OrderStatus)

 Order status. Possible values:
* `none` — no status;
* `driving` — en route;
* `waiting` — is waiting for the client;
* `transporting` — is on the ride now;
* `complete` — order completed;
* `cancelled` — cancelled;
* `calling` — status for a technical error;
* `expired` — status for a technical error;
* `failed` — status for a technical error; 

_Enum:_{.json-schema-reset .json-schema-value} `none`, `driving`, `waiting`, `transporting`, `complete`, `cancelled`, `calling`, `expired`, `failed`
{.table-cell}
||
||

_cancellation_description_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_car_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [OrdersListCar](#entity-OrdersListCar)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "5011ade6ba054dfdb7143c8cc9460dbc",
  "brand_model": "BMW 5er",
  "license": {
    "number": "AA01234567"
  },
  "callsign": "123456789"
}
```

{% endcut %}
{.table-cell}
||
||

_category_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Category](#entity-Category)

 Vehicle category. Possible values:
* `econom` — Economy class;
* `comfort` — Comfort;
* `comfort_plus` — Comfort+;
* `business` — business class vehicle;
* `minivan` — minivan;
* `vip` — A VIP class vehicle;
* `wagon` — multi-purpose;
* `pool` — pool class vehicle;
* `start` — Start class vehicle;
* `standart` — Standart class vehicle;
* `child_tariff` — Kids service class;
* `ultimate` — Premier;
* `maybach` — elite class vehicle;
* `promo` — promotion;
* `premium_van` — cruise van;
* `premium_suv` — premium SUV;
* `suv` — SUV;
* `personal_driver` — personal driver class vehicle;
* `express` — delivery class vehicle;
* `cargo` — a cargo vehicle. 

_Enum:_{.json-schema-reset .json-schema-value} `econom`, `comfort`, `comfort_plus`, `business`, `minivan`, `vip`, `wagon`, `pool`, `start`, `standart`, `child_tariff`, `ultimate`, `maybach`, `promo`, `premium_van`, `premium_suv`, `suv`, `personal_driver`, `express`, `cargo`
{.table-cell}
||
||

_driver_profile_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DriverProfile](#entity-DriverProfile)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "33de650c6a1a40bfa78dd981817da866",
  "name": "Smith, John Richard"
}
```

{% endcut %}
{.table-cell}
||
||

_driver_work_rule_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DriverWorkRule](#entity-DriverWorkRule)

 Driver's working condition 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "e26a3cf21acfe01198d50030487e046b",
  "name": "Rental"
}
```

{% endcut %}
{.table-cell}
||
||

_driving_at_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DateTime](#entity-DateTime)

 ISO 8601 with time zone 

_Example:_{.json-schema-reset .json-schema-example} `2019-08-08T11:58:01+03:00`
{.table-cell}
||
||

_eats_courier_city_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

 Eats courier city. Returned when the value is available in the Eats profile. 

_Example:_{.json-schema-reset .json-schema-example} `Москва`
{.table-cell}
||
||

_eats_courier_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

 Eats courier ID. Returned when the value is available in the Eats profile. 

_Example:_{.json-schema-reset .json-schema-example} `123456`
{.table-cell}
||
||

_eats_courier_type_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

 Eats courier transport type. Returned when the value is available in the Eats profile. 

_Example:_{.json-schema-reset .json-schema-example} `bicycle`
{.table-cell}
||
||

_ended_at_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DateTime](#entity-DateTime)

 ISO 8601 with time zone 

_Example:_{.json-schema-reset .json-schema-example} `2019-08-08T11:58:01+03:00`
{.table-cell}
||
||

_flags_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string[]

 Order flags. 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "example"
]
```

{% endcut %}
{.table-cell}
||
||

_mileage_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_order_time_interval_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DateTimeInterval](#entity-DateTimeInterval)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "from": "2019-08-08T11:58:01+03:00",
  "to": null
}
```

{% endcut %}
{.table-cell}
||
||

_park_details_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [ParkDetails](#entity-ParkDetails)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "tariff": {
    "id": "example",
    "name": "example"
  },
  "passenger": {
    "name": "example",
    "phones": [
      "example"
    ]
  },
  "company": {
    "id": "example",
    "name": "example",
    "slip": "example",
    "comment": "example"
  }
}
```

{% endcut %}
{.table-cell}
||
||

_payment_method_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [PaymentMethod](#entity-PaymentMethod)

 Payment method. Possible values:
* `cash` — cash;
* `cashless` — non-cash;
* `card` — card;
* `internal` — internal;
* `other` — other;
* `corp` — corporate account;
* `prepaid` — advance payment. 

_Enum:_{.json-schema-reset .json-schema-value} `cash`, `cashless`, `card`, `internal`, `other`, `corp`, `prepaid`
{.table-cell}
||
||

_price_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Amount](#entity-Amount)

 Fixed-point sum 

_Max length:_{.json-schema-reset .json-schema-assertion} `20`

_Example:_{.json-schema-reset .json-schema-example} `12345.1434`
{.table-cell}
||
||

_type_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [OrderType](#entity-OrderType)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "4964b852670045b196e526d59915b777",
  "name": "Yandex.Cashless"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "c8d40acf182b4b32af72f6ad2029031b",
  "short_id": 248,
  "status": "complete",
  "created_at": "2019-08-08T11:58:01+03:00",
  "booked_at": null,
  "provider": "platform",
  "category": "econom",
  "amenities": [
    "wifi"
  ],
  "address_from": {
    "address": "8 Liberty Street",
    "lat": 55.762235,
    "lon": 37.609651
  },
  "route_points": [
    null
  ],
  "events": [
    {
      "event_at": null,
      "order_status": null
    }
  ],
  "ended_at": null,
  "payment_method": "card",
  "driver_profile": {
    "id": "33de650c6a1a40bfa78dd981817da866",
    "name": "Smith, John Richard"
  },
  "car": {
    "id": "5011ade6ba054dfdb7143c8cc9460dbc",
    "brand_model": "BMW 5er",
    "license": {
      "number": "AA01234567"
    },
    "callsign": "123456789"
  },
  "type": {
    "id": "4964b852670045b196e526d59915b777",
    "name": "Yandex.Cashless"
  },
  "price": "12345.1434",
  "driver_work_rule": {
    "id": "e26a3cf21acfe01198d50030487e046b",
    "name": "Rental"
  },
  "mileage": "example",
  "cancellation_description": "example",
  "park_details": {
    "tariff": {
      "id": "example",
      "name": "example"
    },
    "passenger": {
      "name": "example",
      "phones": [
        "example"
      ]
    },
    "company": {
      "id": "example",
      "name": "example",
      "slip": "example",
      "comment": "example"
    }
  },
  "order_time_interval": {
    "from": null,
    "to": null
  },
  "driving_at": null,
  "flags": [
    "example"
  ],
  "eats_courier_id": "123456",
  "eats_courier_city": "Москва",
  "eats_courier_type": "bicycle"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersListV2 {#entity-OrdersListV2}

**Type**: [OrderV2](#entity-OrderV2)[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "id": "c8d40acf182b4b32af72f6ad2029031b",
    "short_id": 248,
    "status": "complete",
    "created_at": "2019-08-08T11:58:01+03:00",
    "booked_at": null,
    "provider": "platform",
    "category": "econom",
    "amenities": [
      "wifi"
    ],
    "address_from": {
      "address": "8 Liberty Street",
      "lat": 55.762235,
      "lon": 37.609651
    },
    "route_points": [
      null
    ],
    "events": [
      {
        "event_at": null,
        "order_status": null
      }
    ],
    "ended_at": null,
    "payment_method": "card",
    "driver_profile": {
      "id": "33de650c6a1a40bfa78dd981817da866",
      "name": "Smith, John Richard"
    },
    "car": {
      "id": "5011ade6ba054dfdb7143c8cc9460dbc",
      "brand_model": "BMW 5er",
      "license": {
        "number": "AA01234567"
      },
      "callsign": "123456789"
    },
    "type": {
      "id": "4964b852670045b196e526d59915b777",
      "name": "Yandex.Cashless"
    },
    "price": "12345.1434",
    "driver_work_rule": {
      "id": "e26a3cf21acfe01198d50030487e046b",
      "name": "Rental"
    },
    "mileage": "example",
    "cancellation_description": "example",
    "park_details": {
      "tariff": {
        "id": "example",
        "name": "example"
      },
      "passenger": {
        "name": "example",
        "phones": [
          "example"
        ]
      },
      "company": {
        "id": "example",
        "name": "example",
        "slip": "example",
        "comment": "example"
      }
    },
    "order_time_interval": {
      "from": null,
      "to": null
    },
    "driving_at": null,
    "flags": [
      "example"
    ],
    "eats_courier_id": "123456",
    "eats_courier_city": "Москва",
    "eats_courier_type": "bicycle"
  }
]
```

{% endcut %}

</div>

<div class="openapi-entity">

### ResponseCursor {#entity-ResponseCursor}

 Cursor for obtaining the next data chunk 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} ``

</div>

</div>

<div class="openapi__response__code__400">

## 400 Bad Request

 Invalid request parameters 

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": "example",
  "message": "Textual description of the error"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

 Human-readable error message 

_Example:_{.json-schema-reset .json-schema-example} `Textual description of the error`
{.table-cell}
||
||

_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

 Machine-readable error code 

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__401">

## 401 Unauthorized

 Request authorization parameters are missing 

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": "example",
  "message": "Textual description of the error"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

 Human-readable error message 

_Example:_{.json-schema-reset .json-schema-example} `Textual description of the error`
{.table-cell}
||
||

_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

 Machine-readable error code 

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__403">

## 403 Forbidden

 Insufficient rights to execute the request 

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": "example",
  "message": "Textual description of the error"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

 Human-readable error message 

_Example:_{.json-schema-reset .json-schema-example} `Textual description of the error`
{.table-cell}
||
||

_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

 Machine-readable error code 

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__429">

## 429 Too Many Requests

 Limit of requests was exceeded 

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": "example",
  "message": "Textual description of the error"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

 Human-readable error message 

_Example:_{.json-schema-reset .json-schema-example} `Textual description of the error`
{.table-cell}
||
||

_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

 Machine-readable error code 

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__500">

## 500 Internal Server Error

 Internal server error 

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": "example",
  "message": "Textual description of the error"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

 Human-readable error message 

_Example:_{.json-schema-reset .json-schema-example} `Textual description of the error`
{.table-cell}
||
||

_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

 Machine-readable error code 

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

</div>

[*Deprecated]: No longer supported, please use an alternative and newer version.