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

HTTP-запрос

GET https://fleet-api.taxi.yandex.net/v2/parks/vehicles/car?vehicle_id={string}

Query-параметры

vehicle_id

string

Идентификатор ТС

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

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

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

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

Ответы

Код 200

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

{
  "cargo": {
    "cargo_hold_dimensions": {
      "height": 150,
      "length": 200,
      "width": 200
    },
    "cargo_loaders": 1,
    "carrying_capacity": 500
  },
  "child_safety": {
    "booster_count": 2
  },
  "park_profile": {
    "amenities": [
      "wifi"
    ],
    "callsign": "123456789",
    "categories": [
      "econom"
    ],
    "comment": "good car",
    "fuel_type": "gas",
    "is_park_property": true,
    "leasing_conditions": {
      "company": "leasing company",
      "interest_rate": "11.7",
      "monthly_payment": 20000,
      "start_date": "2022-01-01",
      "term": 30
    },
    "license_owner_id": "6k054dfdb9i5345ifsdfvpfu8c8cc946",
    "ownership_type": "park",
    "status": "working",
    "tariffs": [
      "string"
    ]
  },
  "vehicle_licenses": {
    "licence_number": "123456789",
    "licence_plate_number": "Т8654Т99",
    "registration_certificate": "123456789"
  },
  "vehicle_specifications": {
    "body_number": "123456789",
    "brand": "Mercedes-Benz",
    "color": "Черный",
    "mileage": 5000,
    "model": "E-klasse",
    "transmission": "automatic",
    "vin": "12345678909876543",
    "year": 2019
  }
}
Скопировано

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

Свернуть всё

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

Поля

cargo	object
cargo.cargo_hold_dimensions	object Размеры грузового отсека
cargo.cargo_hold_dimensions.height *	integer Высота (в см). Допустимое значение высоты от 90 до 250 см Минимальное значение: `0`.
cargo.cargo_hold_dimensions.length *	integer Длина (в см). Допустимое значение длины от 170 до 601 см Минимальное значение: `0`.
cargo.cargo_hold_dimensions.width *	integer Ширина (в см). Допустимое значение ширины от 96 до 250 см Минимальное значение: `0`.
cargo.cargo_loaders	integer Число грузчиков. Допустимое количество грузчиков от 0 до 2 Минимальное значение: `0`.
cargo.carrying_capacity	integer Грузоподъемность (в кг). Допустимое значение грузоподъемности от 300 до 6000 кг Минимальное значение: `0`.
child_safety	object
child_safety.booster_count *	integer Количество бустеров Минимальное значение: `0`. Максимальное значение: `3`.
park_profile *	object
park_profile.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`
park_profile.callsign *	string Позывной
park_profile.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` - грузовой.
park_profile.comment	string Описание ТС
park_profile.fuel_type	string Тип топлива
park_profile.is_park_property	boolean Парковая машина
park_profile.leasing_conditions	object Условия лизинга
park_profile.leasing_conditions.company *	string Лизинговая компания
park_profile.leasing_conditions.interest_rate *	string Процентная ставка лизинга
park_profile.leasing_conditions.monthly_payment *	integer Ежемесячный платеж Минимальное значение: `0`.
park_profile.leasing_conditions.start_date *	string Дата начала лизинга
park_profile.leasing_conditions.term *	integer Срок лизинга (Количество месяцев) Минимальное значение: `0`.
park_profile.license_owner_id	string Идентификатор собственника лицензии
park_profile.ownership_type	string Тип собственности Возможные значения park leasing
park_profile.status *	string Статус ТС. Текущие статусы: `unknown` - статус неизвестен; `working` - в данный момент используется для совершения поездок; `not_working` - в данный момент не используется для совершения поездок; `repairing` — подвергается техническому обслуживанию или ремонту; `no_driver` - за машиной не закреплен водитель; `pending` - ведется обработка сведений об автомобиле.
park_profile.tariffs[]	array Список тарифов парка
vehicle_licenses *	object
vehicle_licenses.licence_number	string Номер лицензии на такси
vehicle_licenses.licence_plate_number *	string Государственный регистрационный номер
vehicle_licenses.registration_certificate	string Номер свидетельства о регистрации ТС (Обязательное поле для России)
vehicle_specifications *	object
vehicle_specifications.body_number	string Номер кузова из СТС ТС
vehicle_specifications.brand *	string Марка ТС
vehicle_specifications.color *	string Цвет ТС Возможные значения Белый Желтый Бежевый Черный Голубой Серый Красный Оранжевый Синий Зеленый Коричневый Фиолетовый Розовый
vehicle_specifications.mileage	integer Пробег Минимальное значение: `0`.
vehicle_specifications.model *	string Модель ТС
vehicle_specifications.transmission *	string Тип коробки передач Возможные значения unknown mechanical automatic robotic variator
vehicle_specifications.vin	string VIN (Обязательное поле для России)
vehicle_specifications.year *	integer Год выпуска ТС

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

Код 401

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

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

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

Свернуть всё

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

Поля

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

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

Код 403

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

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

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

Свернуть всё

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

Поля

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

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

Код 404

Запрашиваемый ресурс не найден

{
  "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 GET "https://fleet-api.taxi.yandex.net/v2/parks/vehicles/car?vehicle_id={string}" \
-H "X-Park-ID: ee6f33c4562b4e1f8646d157bd70b2c4" \
-H "X-Client-ID: <Идентификатор клиента>" \
-H "X-API-Key: <API-ключ>"
Скопировано

Responses:

{
  "cargo": {
    "cargo_hold_dimensions": {
      "height": 150,
      "length": 200,
      "width": 200
    },
    "cargo_loaders": 1,
    "carrying_capacity": 500
  },
  "child_safety": {
    "booster_count": 2
  },
  "park_profile": {
    "amenities": [
      "wifi"
    ],
    "callsign": "123456789",
    "categories": [
      "econom"
    ],
    "comment": "good car",
    "fuel_type": "gas",
    "is_park_property": true,
    "leasing_conditions": {
      "company": "leasing company",
      "interest_rate": "11.7",
      "monthly_payment": 20000,
      "start_date": "2022-01-01",
      "term": 30
    },
    "license_owner_id": "6k054dfdb9i5345ifsdfvpfu8c8cc946",
    "ownership_type": "park",
    "status": "working",
    "tariffs": [
      null
    ]
  },
  "vehicle_licenses": {
    "licence_number": "123456789",
    "licence_plate_number": "Т8654Т99",
    "registration_certificate": "123456789"
  },
  "vehicle_specifications": {
    "body_number": "123456789",
    "brand": "Mercedes-Benz",
    "color": "Черный",
    "mileage": 5000,
    "model": "E-klasse",
    "transmission": "automatic",
    "vin": "12345678909876543",
    "year": 2019
  }
}
Скопировано

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

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

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

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

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