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

Request

POST

https://fleet-api.taxi.yandex.net/v1/parks/cars/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

{
    "limit": 100,
    "offset": 0,
    "query": {
        "park": {
            "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
            "car": {
                "id": [
                    "5011ade6ba054dfdb7143c8cc9460dbc"
                ],
                "status": [
                    "working"
                ],
                "amenities": [
                    [
                        "wifi"
                    ]
                ],
                "categories": [
                    [
                        "econom"
                    ]
                ],
                "is_rental": false
            }
        },
        "text": "string"
    },
    "fields": {
        "car": [
            "color"
        ]
    }
}

Name	Description
limit*	Type: integer Ограничение сверху на число автомобилей в ответе Default: `1000` Example: `100` Min value: `1` Max value: `1000`
query*	Type: CarsListQuery Поисковые ограничения
fields	Type: CarsListFields Данные, которые необходимо извлечь
offset	Type: integer Отступ, начиная с которого возвращаются автомобили в ответе Default: `0` Example: `0` Min value: `0`

CarsListQuery

Поисковые ограничения

Name

Description

park*

Type: CarsListQueryPark

text

Type: string

Текстовый поисковый запрос по данным автомобиля

Example: ``

CarsListFields

Данные, которые необходимо извлечь

Name

Description

car

Type: VehicleField[]

Данные ТС, которые необходимо извлечь. Допустимые значения:

id — идентификатор;
status - статус;
amenities - услуги;
category - категории;
callsign - позывной;
brand — марка;
model — модель;
year — год выпуска;
color - цвет;
number — регистрационный номер;
registration_cert - свидетельство о регистрации (СТС);
vin - идентификационный номер (VIN).
Поле ТС

Example: color

Enum: id, status, amenities, category, callsign, brand, model, year, color, number, registration_cert, vin

CarsListQueryPark

Name

Description

id*

Type: string

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

Example: ee6f33c4562b4e1f8646d157bd70b2c4

Min length: 1

Max length: 100

car

Type: CarsListQueryParkCar

Поисковые ограничения на автомобиль

VehicleField

Поле ТС

Type

Description

VehicleField

Example: color

Enum: id, status, amenities, category, callsign, brand, model, year, color, number, registration_cert, vin

CarsListQueryParkCar

Поисковые ограничения на автомобиль

Name	Description
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`
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`
id	Type: string[] Идентификатор автомобиля Example: `5011ade6ba054dfdb7143c8cc9460dbc` Min length: `1` Max length: `100` Max items: `100` Min items: `1`
is_rental	Type: boolean Парковая машина
status	Type: string[] Статус ТС. Текущие статусы: `unknown` - статус неизвестен; `working` - в данный момент используется для совершения поездок; `not_working` - в данный момент не используется для совершения поездок; `repairing` — подвергается техническому обслуживанию или ремонту; `no_driver` - за машиной не закреплен водитель; `pending` - ведется обработка сведений об автомобиле. Example: `working`

Responses

200 OK

Список автомобилей

Body

application/json

{
    "limit": 100,
    "offset": 0,
    "total": 357,
    "cars": [
        {
            "id": "2111ade6gk054dfdb9iu8c8cc9460mks",
            "status": "working",
            "amenities": [
                [
                    "wifi"
                ]
            ],
            "category": [
                [
                    "econom"
                ]
            ],
            "callsign": "123456789",
            "brand": "Mercedes-Benz",
            "model": "E-klasse",
            "year": 2019,
            "color": "Черный",
            "number": "Т8654Т99",
            "registration_cert": "123456789",
            "vin": "12345678909876543"
        }
    ]
}

Name	Description
cars*	Type: Vehicle[] Данные ТС
limit*	Type: integer Ограничение сверху на число автомобилей в ответе Default: `1000` Example: `100` Min value: `1` Max value: `1000`
offset*	Type: integer Отступ, начиная с которого возвращаются автомобили в ответе Default: `0` Example: `0` Min value: `0`
total*	Type: integer Общее число автомобилей, удовлетворяющих запросу Example: `357` Min value: `0`

Vehicle

Данные ТС

Name	Description
id*	Type: string Идентификатор ТС Example: `2111ade6gk054dfdb9iu8c8cc9460mks`
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`
brand	Type: string Марка ТС Example: `Mercedes-Benz`
callsign	Type: string Позывной Example: `123456789`
category	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`
color	Type: ColorEnum Цвет ТС Example: `Черный` Enum: `Белый`, `Желтый`, `Бежевый`, `Черный`, `Голубой`, `Серый`, `Красный`, `Оранжевый`, `Синий`, `Зеленый`, `Коричневый`, `Фиолетовый`, `Розовый`
model	Type: string Модель ТС Example: `E-klasse`
number	Type: string Государственный регистрационный номер Example: `Т8654Т99`
registration_cert	Type: string Номер свидетельства о регистрации ТС (Обязательное поле для России) Example: `123456789`
status	Type: string Статус ТС. Текущие статусы: `unknown` - статус неизвестен; `working` - в данный момент используется для совершения поездок; `not_working` - в данный момент не используется для совершения поездок; `repairing` — подвергается техническому обслуживанию или ремонту; `no_driver` - за машиной не закреплен водитель; `pending` - ведется обработка сведений об автомобиле. Example: `working`
vin	Type: string VIN (Обязательное поле для России) Example: `12345678909876543`
year	Type: integer Год выпуска ТС Example: `2019`

ColorEnum

Цвет ТС

Type

Description

ColorEnum

Example: Черный

Enum: Белый, Желтый, Бежевый, Черный, Голубой, Серый, Красный, Оранжевый, Синий, Зеленый, Коричневый, Фиолетовый, Розовый

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

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

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

Получение автомобиля

Изменить привязанное к авто условие аренды