Получение списка заказов

Request

POST

https://fleet-api.taxi.yandex.net/v1/parks/orders/list

Headers

Name

Description

X-API-Key*

Type: string

API-ключ

Example: <API-ключ>

Min length: 1

X-Client-ID*

Type: string

Идентификатор клиента

Example: <Идентификатор клиента>

Min length: 1

Body

application/json

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

Name	Description
limit*	Type: integer Ограничение сверху на число заказов в ответе Example: `100` Min value: `1` Max value: `500`
query*	Type: OrdersListQuery
cursor	Type: string Курсор для получения следующий порции данных, значение должно быть взято из ответа на предыдущий запрос Min length: `1`

OrdersListQuery

Name	Description
park*	Type: OrdersListQueryPark

OrdersListQueryPark

Name	Description
id*	Type: string Идентификатор партнёра Example: `ee6f33c4562b4e1f8646d157bd70b2c4` Min length: `1` Max length: `100`
order*	Type: OrdersListQueryParkOrder Обязательно наличие одного из booked_at или ended_at
car	Type: OrdersListQueryParkCar
driver_profile	Type: OrdersListQueryParkDriverProfile

OrdersListQueryParkOrder

Обязательно наличие одного из booked_at или ended_at

Name	Description
booked_at	Type: DateTimeInterval
categories	Type: string[] Список категорий ТС. Допустимые значения: `econom` - эконом; `comfort` - комфорт; `comfort_plus` - комфорт+; `business` - бизнес; `minivan` - минивен; `vip` - VIP; `wagon` - универсальный; `pool` - pool; `start` - старт; `standart` - стандарт; `ultimate` - премьер; `maybach` - elite; `promo` - промо; `premium_van` - круиз; `premium_suv` - премиум внедорожник; `suv` - внедорожник; `personal_driver` - персональный водитель; `express` - доставка; `cargo` - грузовой. Example: `econom` Enum: `econom`, `comfort`, `comfort_plus`, `business`, `minivan`, `vip`, `wagon`, `pool`, `start`, `standart`, `ultimate`, `maybach`, `promo`, `premium_van`, `premium_suv`, `suv`, `personal_driver`, `express`, `cargo`
ended_at	Type: DateTimeInterval
ids	Type: string[] Идентификатор заказа Example: `c8d40acf182b4b32af72f6ad2029031b` Min length: `1` Max length: `100` Min items: `1` Max items: `100`
payment_methods	Type: PaymentMethod[] Способ оплаты. Допустимые значения: `cash` - наличные; `cashless` - безнал; `card` - карта; `internal` - внутренний; `other` - другое; `corp` - корп. счёт; `prepaid` - предоплата. Example: `card` Enum: `cash`, `cashless`, `card`, `internal`, `other`, `corp`, `prepaid` Min items: `1`
price	Type: PriceInterval
providers	Type: Provider[] Example: `platform` Enum: `none`, `partner`, `platform` Min items: `1`
short_ids	Type: integer[] Порядковый номер заказ (с учётом несостоявшихся заказов) Example: `248` Min value: `0` Min items: `1` Max items: `100`
statuses	Type: OrderStatus[] Статус заказа. Допустимые значения: `none` - без статуса; `driving` - в пути; `waiting` - ждёт клиента; `transporting` - везёт клиента; `complete` - выполнен; `cancelled` - отменён; `calling` - ошибка, технический статус; `expired` - ошибка, технический статус; `failed` - ошибка, технический статус. Example: `complete` Enum: `none`, `driving`, `waiting`, `transporting`, `complete`, `cancelled`, `calling`, `expired`, `failed` Min items: `1`
type	Type: QueryParkOrderType

OrdersListQueryParkCar

Name

Description

id*

Type: string

Идентификатор автомобиля

Example: 5011ade6ba054dfdb7143c8cc9460dbc

Min length: 1

Max length: 100

OrdersListQueryParkDriverProfile

Name

Description

id*

Type: string

Идентификатор водителя

Example: 33de650c6a1a40bfa78dd981817da866

Min length: 1

Max length: 100

DateTimeInterval

Name

Description

from*

Type: string<date-time>

ISO 8601 с временной зоной

Example: 2019-08-08T11:58:01+03:00

to*

Type: string<date-time>

ISO 8601 с временной зоной

Example: 2019-08-08T11:58:01+03:00

PaymentMethod

Способ оплаты. Допустимые значения:

cash - наличные;
cashless - безнал;
card - карта;
internal - внутренний;
other - другое;
corp - корп. счёт;
prepaid - предоплата.

Type

Description

PaymentMethod

Example: card

Enum: cash, cashless, card, internal, other, corp, prepaid

PriceInterval

Name

Description

from

Type: string

Сумма с фиксированной точностью

Example: 12345.1434

Max length: 20

Type: string

Сумма с фиксированной точностью

Example: 12345.1434

Max length: 20

Provider

Type

Description

Provider

Example: platform

Enum: none, partner, platform

OrderStatus

Статус заказа. Допустимые значения:

none - без статуса;
driving - в пути;
waiting - ждёт клиента;
transporting - везёт клиента;
complete - выполнен;
cancelled - отменён;
calling - ошибка, технический статус;
expired - ошибка, технический статус;
failed - ошибка, технический статус.

Type

Description

OrderStatus

Example: complete

Enum: none, driving, waiting, transporting, complete, cancelled, calling, expired, failed

QueryParkOrderType

Name

Description

ids*

Type: string[]

Идентификатор типа заказа

Example: 4964b852670045b196e526d59915b777

Min length: 1

Min items: 1

Max items: 100

Responses

200 OK

Список заказов

Body

application/json

{
    "orders": [
        {
            "id": "c8d40acf182b4b32af72f6ad2029031b",
            "short_id": 248,
            "status": "complete",
            "created_at": "2019-08-08T11:58:01+03:00",
            "booked_at": "2019-08-08T11:58:01+03:00",
            "provider": "platform",
            "category": "econom",
            "amenities": [
                [
                    "wifi"
                ]
            ],
            "address_from": {
                "address": "Тверская улица, 8",
                "lat": 55.762235,
                "lon": 37.609651
            },
            "route_points": [
                {
                    "address": "Тверская улица, 8",
                    "lat": 55.762235,
                    "lon": 37.609651
                }
            ],
            "events": [
                {
                    "event_at": "2019-08-08T11:58:01+03:00",
                    "order_status": "complete"
                }
            ],
            "ended_at": "2019-08-08T11:58:01+03:00",
            "payment_method": "card",
            "driver_profile": {
                "id": "33de650c6a1a40bfa78dd981817da866",
                "name": "Иванов Пётр Николаевич"
            },
            "car": {
                "id": "5011ade6ba054dfdb7143c8cc9460dbc",
                "brand_model": "BMW 5er",
                "license": {
                    "number": "AA01234567"
                },
                "callsign": "123456789"
            },
            "type": {
                "id": "4964b852670045b196e526d59915b777",
                "name": "Яндекс.Безналичный"
            },
            "price": "12345.1434",
            "driver_work_rule": {
                "id": "e26a3cf21acfe01198d50030487e046b",
                "name": "Аренда"
            },
            "mileage": "string",
            "cancellation_description": "string",
            "park_details": {
                "tariff": {
                    "id": "string",
                    "name": "string"
                },
                "passenger": {
                    "name": "string",
                    "phones": [
                        "string"
                    ]
                },
                "company": {
                    "id": "string",
                    "name": "string",
                    "slip": "string",
                    "comment": "string"
                }
            }
        }
    ],
    "limit": 100,
    "cursor": "string"
}

Name	Description
limit*	Type: integer Ограничение сверху на число заказов в ответе Example: `100` Min value: `1` Max value: `500`
orders*	Type: Order[]
cursor	Type: string Курсор для получения следующий порции данных Example: ``

Order

Name	Description
address_from*	Type: AddressInfo
amenities*	Type: string[] Удобства в ТС. Допустимые значения: `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` Example: `wifi` Enum: `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`
booked_at*	Type: string<date-time> ISO 8601 с временной зоной Example: `2019-08-08T11:58:01+03:00`
created_at*	Type: string<date-time> ISO 8601 с временной зоной Example: `2019-08-08T11:58:01+03:00`
events*	Type: Event[]
id*	Type: string Идентификатор заказа Example: `c8d40acf182b4b32af72f6ad2029031b` Min length: `1` Max length: `100`
provider*	Type: Provider Example: `platform` Enum: `none`, `partner`, `platform`
route_points*	Type: AddressInfo[]
short_id*	Type: integer Порядковый номер заказ (с учётом несостоявшихся заказов) Example: `248` Min value: `0`
status*	Type: OrderStatus Статус заказа. Допустимые значения: `none` - без статуса; `driving` - в пути; `waiting` - ждёт клиента; `transporting` - везёт клиента; `complete` - выполнен; `cancelled` - отменён; `calling` - ошибка, технический статус; `expired` - ошибка, технический статус; `failed` - ошибка, технический статус. Example: `complete` Enum: `none`, `driving`, `waiting`, `transporting`, `complete`, `cancelled`, `calling`, `expired`, `failed`
cancellation_description	Type: string
car	Type: OrdersListCar
category	Type: Category Категория ТС. Допустимые значения: `econom` - эконом; `comfort` - комфорт; `comfort_plus` - комфорт+; `business` - бизнес; `minivan` - минивен; `vip` - VIP; `wagon` - универсальный; `pool` - pool; `start` - старт; `standart` - стандарт; `child_tariff` - детский; `ultimate` - премьер; `maybach` - elite; `promo` - промо; `premium_van` - круиз; `premium_suv` - премиум внедорожник; `suv` - внедорожник; `personal_driver` - персональный водитель; `express` - доставка; `cargo` - грузовой. Example: `econom` Enum: `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`
driver_profile	Type: object
driver_work_rule	Type: object Условие работы водителя
ended_at	Type: string<date-time> ISO 8601 с временной зоной Example: `2019-08-08T11:58:01+03:00`
mileage	Type: string
park_details	Type: ParkDetails
payment_method	Type: PaymentMethod Способ оплаты. Допустимые значения: `cash` - наличные; `cashless` - безнал; `card` - карта; `internal` - внутренний; `other` - другое; `corp` - корп. счёт; `prepaid` - предоплата. Example: `card` Enum: `cash`, `cashless`, `card`, `internal`, `other`, `corp`, `prepaid`
price	Type: string Сумма с фиксированной точностью Example: `12345.1434` Max length: `20`
type	Type: OrderType

AddressInfo

Name	Description
address*	Type: string Адрес заказа Example: `Тверская улица, 8`
lat*	Type: number Географическая широта Example: `55.762235`
lon*	Type: number Географическая долгота Example: `37.609651`

Event

Name

Description

event_at*

Type: string<date-time>

ISO 8601 с временной зоной

Example: 2019-08-08T11:58:01+03:00

order_status*

Type: OrderStatus

Статус заказа. Допустимые значения:

none - без статуса;
driving - в пути;
waiting - ждёт клиента;
transporting - везёт клиента;
complete - выполнен;
cancelled - отменён;
calling - ошибка, технический статус;
expired - ошибка, технический статус;
failed - ошибка, технический статус.

Example: complete

Enum: none, driving, waiting, transporting, complete, cancelled, calling, expired, failed

OrdersListCar

Name	Description
brand_model	Type: string Марка и модель автомобиля Example: `BMW 5er`
callsign	Type: string Позывной Example: `123456789`
id	Type: string Идентификатор автомобиля Example: `5011ade6ba054dfdb7143c8cc9460dbc` Min length: `1` Max length: `100`
license	Type: License

Name

Description

id*

Type: string

Идентификатор типа заказа

Example: 4964b852670045b196e526d59915b777

Min length: 1

name*

Type: string

Название типа заказа

Example: Яндекс.Безналичный

License

Name

Description

number*

Type: string

Регистрационный номер ТС

Example: AA01234567

Company

Name	Description
comment	Type: string
id	Type: string
name	Type: string
slip	Type: string

Passenger

Name

Description

name

Type: string

phones

Type: string[]

Min length: 1

Min items: 1

Max items: 3

OrderTariff

Тарифы парка

Name	Description
id*	Type: string
name*	Type: string

400 Bad Request

Некорректные параметры запроса

Body

application/json

{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

401 Unauthorized

Отсутствуют параметры авторизации запроса

Body

application/json

{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

403 Forbidden

Недостаточно прав для выполнения запроса

Body

application/json

{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

429 Too Many Requests

Превышено допустимое число запросов

Body

application/json

{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

500 Internal Server Error

Внутренняя ошибка сервера

Body

application/json

{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

Была ли статья полезна?

Получение списка условий работы

Получение трека по заказу

Получение списка заказов

Request

Headers

Body

OrdersListQuery

OrdersListQueryPark

OrdersListQueryParkOrder

OrdersListQueryParkCar

OrdersListQueryParkDriverProfile

DateTimeInterval

PaymentMethod

PriceInterval

Provider

OrderStatus

QueryParkOrderType

Responses

200 OK

Body

Order

AddressInfo

Event

OrdersListCar

Category

ParkDetails

OrderType

License

Company

Passenger

OrderTariff

400 Bad Request

Body

401 Unauthorized

Body

403 Forbidden

Body

429 Too Many Requests

Body

500 Internal Server Error

Body

Была ли статья полезна?