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

HTTP-запрос

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

Заголовки запроса

X-Client-ID *	string Идентификатор клиента
X-API-Key *	string API-ключ

* Обязательный параметр

Тело запроса

{
  "fields": {
    "car": [
      "color"
    ]
  },
  "limit": 100,
  "offset": 0,
  "query": {
    "park": {
      "car": {
        "amenities": [
          "wifi"
        ],
        "categories": [
          "econom"
        ],
        "id": [
          "5011ade6ba054dfdb7143c8cc9460dbc"
        ],
        "is_rental": true,
        "status": [
          "working"
        ]
      },
      "id": "ee6f33c4562b4e1f8646d157bd70b2c4"
    },
    "text": ""
  }
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

fields	object Данные, которые необходимо извлечь
fields.car[]	array Данные ТС, которые необходимо извлечь. Допустимые значения: `id` — идентификатор; `status` - статус; `amenities` - услуги; `category` - категории; `callsign` - позывной; `brand` — марка; `model` — модель; `year` — год выпуска; `color` - цвет; `number` — регистрационный номер; `registration_cert` - свидетельство о регистрации (СТС); `vin` - идентификационный номер (VIN).
limit *	integer Ограничение сверху на число автомобилей в ответе Минимальное значение: `1`. Максимальное значение: `1000`. Значение по умолчанию: `1000`.
offset	integer Отступ, начиная с которого возвращаются автомобили в ответе Минимальное значение: `0`.
query *	object Поисковые ограничения
query.park *	object
query.park.car	object Поисковые ограничения на автомобиль
query.park.car.amenities[]	array Удобства в ТС. Допустимые значения: `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`
query.park.car.categories[]	array Список категорий ТС. Допустимые значения: `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` - грузовой.
query.park.car.id[]	array
query.park.car.is_rental	boolean Парковая машина
query.park.car.status[]	array Статус ТС. Текущие статусы: `unknown` - статус неизвестен; `working` - в данный момент используется для совершения поездок; `not_working` - в данный момент не используется для совершения поездок; `repairing` — подвергается техническому обслуживанию или ремонту; `no_driver` - за машиной не закреплен водитель; `pending` - ведется обработка сведений об автомобиле.
query.park.id *	string Идентификатор партнёра
query.text	string Текстовый поисковый запрос по данным автомобиля

* Обязательный параметр

Ответы

Код 200

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

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

Представление

Свернуть всё

Развернуть всё

Поля

cars[] *	array
cars[].amenities[]	array Удобства в ТС. Допустимые значения: `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`
cars[].brand	string Марка ТС
cars[].callsign	string Позывной
cars[].category[]	array Список категорий ТС. Допустимые значения: `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` - грузовой.
cars[].color	string Цвет ТС Возможные значения Белый Желтый Бежевый Черный Голубой Серый Красный Оранжевый Синий Зеленый Коричневый Фиолетовый Розовый
cars[].id *	string Идентификатор ТС
cars[].model	string Модель ТС
cars[].number	string Государственный регистрационный номер
cars[].registration_cert	string Номер свидетельства о регистрации ТС (Обязательное поле для России)
cars[].status	string Статус ТС. Текущие статусы: `unknown` - статус неизвестен; `working` - в данный момент используется для совершения поездок; `not_working` - в данный момент не используется для совершения поездок; `repairing` — подвергается техническому обслуживанию или ремонту; `no_driver` - за машиной не закреплен водитель; `pending` - ведется обработка сведений об автомобиле.
cars[].vin	string VIN (Обязательное поле для России)
cars[].year	integer Год выпуска ТС
limit *	integer Ограничение сверху на число автомобилей в ответе Минимальное значение: `1`. Максимальное значение: `1000`. Значение по умолчанию: `1000`.
offset *	integer Отступ, начиная с которого возвращаются автомобили в ответе Минимальное значение: `0`.
total *	integer Общее число автомобилей, удовлетворяющих запросу Минимальное значение: `0`.

* Обязательный параметр

Код 400

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

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

Представление

Свернуть всё

Развернуть всё

Поля

code	string Машиночитаемый код ошибки
message *	string Человекочитаемое сообщение об ошибке

* Обязательный параметр

Код 401

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

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

Представление

Свернуть всё

Развернуть всё

Поля

code	string Машиночитаемый код ошибки
message *	string Человекочитаемое сообщение об ошибке

* Обязательный параметр

Код 403

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

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

Представление

Свернуть всё

Развернуть всё

Поля

code	string Машиночитаемый код ошибки
message *	string Человекочитаемое сообщение об ошибке

* Обязательный параметр

Код 429

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

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

Представление

Свернуть всё

Развернуть всё

Поля

code	string Машиночитаемый код ошибки
message *	string Человекочитаемое сообщение об ошибке

* Обязательный параметр

Код 500

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

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

Представление

Свернуть всё

Развернуть всё

Поля

code	string Машиночитаемый код ошибки
message *	string Человекочитаемое сообщение об ошибке

* Обязательный параметр

Пример

Request:

curl -X POST "https://fleet-api.taxi.yandex.net/v1/parks/cars/list" \
-H "X-Client-ID: <Идентификатор клиента>" \
-H "X-API-Key: <API-ключ>" \
-d '{
  "fields": {
    "car": [
      "color"
    ]
  },
  "limit": 100,
  "offset": 0,
  "query": {
    "park": {
      "car": {
        "amenities": [
          "wifi"
        ],
        "categories": [
          "econom"
        ],
        "id": [
          "5011ade6ba054dfdb7143c8cc9460dbc"
        ],
        "is_rental": true,
        "status": [
          "working"
        ]
      },
      "id": "ee6f33c4562b4e1f8646d157bd70b2c4"
    },
    "text": ""
  }
}'
Скопировано

Responses:

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

{
  "message": "Текстовое описание ошибки"
}
Скопировано

{
  "message": "Текстовое описание ошибки"
}
Скопировано

{
  "message": "Текстовое описание ошибки"
}
Скопировано

{
  "message": "Текстовое описание ошибки"
}
Скопировано

{
  "message": "Текстовое описание ошибки"
}
Скопировано