- Request
- Headers
- Body
- Model
- Brand
- ColorEnum
- Year
- Transmission
- VIN
- BodyNumber
- Mileage
- VehicleSpecifications
- LicencePlateNumber
- RegistrationCertificate
- LicenceNumber
- VehicleLicenses
- Callsign
- Status
- LicenseOwnerId
- IsParkProperty
- OwnershipType
- LeasingCompany
- LeasingStartDate
- LeasingTerm
- LeasingMonthlyPayment
- LeasingInterestRate
- LeasingConditions
- Amenities
- Categories
- Tariff
- Tariffs
- Comment
- FuelType
- ParkProfile
- BoosterCount
- ChildSafety
- CargoLoaders
- CarryingCapacity
- Length
- Width
- Height
- Dimensions
- Cargo
- Responses
- 200 OK
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 429 Too Many Requests
- 500 Internal Server Error
Создание автомобиля
Создание автомобиля
Request
POST
https://fleet-api.taxi.yandex.net/v2/parks/vehicles/car
Headers
|
Name |
Description |
|
X-API-Key |
Type: string API-ключ Min length: Example: |
|
X-Client-ID |
Type: string Идентификатор клиента Min length: Example: |
|
X-Idempotency-Token |
Type: string Токен идемпотентности запроса. Должен состоять только из печатных ASCII символов Min length: Max length: Example: |
|
X-Park-ID |
Type: string Идентификатор партнера Example: |
Body
application/json
{
"vehicle_specifications": {
"model": "E-klasse",
"brand": "Mercedes-Benz",
"color": "Черный",
"year": 2019,
"transmission": "automatic",
"vin": "12345678909876543",
"body_number": "123456789",
"mileage": 5000
},
"vehicle_licenses": {
"licence_plate_number": "Т8654Т99",
"registration_certificate": "123456789",
"licence_number": "123456789"
},
"park_profile": {
"callsign": "123456789",
"status": "working",
"license_owner_id": "6k054dfdb9i5345ifsdfvpfu8c8cc946",
"is_park_property": true,
"ownership_type": "park",
"leasing_conditions": {
"company": "leasing company",
"start_date": "2022-01-01",
"term": 30,
"monthly_payment": 20000,
"interest_rate": "11.7"
},
"amenities": [
"wifi"
],
"categories": [
"econom"
],
"tariffs": [
"Комфорт"
],
"comment": "good car",
"fuel_type": "petrol"
},
"child_safety": {
"booster_count": 2
},
"cargo": {
"cargo_loaders": 1,
"carrying_capacity": 500,
"cargo_hold_dimensions": {
"length": 200,
"width": 200,
"height": 150
}
}
}
|
Name |
Description |
|
park_profile |
Type: ParkProfile Example
|
|
vehicle_licenses |
Type: VehicleLicenses Example
|
|
vehicle_specifications |
Type: VehicleSpecifications Example
|
|
cargo |
Type: Cargo Example
|
|
child_safety |
Type: ChildSafety Example
|
Model
Модель ТС
Type: string
Example: E-klasse
Brand
Марка ТС
Type: string
Example: Mercedes-Benz
ColorEnum
Цвет ТС
Type: string
Enum: Белый, Желтый, Бежевый, Черный, Голубой, Серый, Красный, Оранжевый, Синий, Зеленый, Коричневый, Фиолетовый, Розовый
Year
Год выпуска ТС
Type: integer
Transmission
Тип коробки передач
Type: string
Enum: mechanical, automatic, robotic, variator
VIN
VIN (Обязательное поле для России)
Type: string
Example: 12345678909876543
BodyNumber
Номер кузова из СТС ТС
Type: string
Example: 123456789
Mileage
Пробег
Type: integer
Min value: 0
VehicleSpecifications
|
Name |
Description |
|
brand |
Type: Brand Марка ТС Example: |
|
color |
Type: ColorEnum Цвет ТС Enum: |
|
model |
Type: Model Модель ТС Example: |
|
transmission |
Type: Transmission Тип коробки передач Enum: |
|
year |
Type: Year Год выпуска ТС Example: |
|
body_number |
Type: BodyNumber Номер кузова из СТС ТС Example: |
|
mileage |
Type: Mileage Пробег Min value: Example: |
|
vin |
Type: VIN VIN (Обязательное поле для России) Example: |
Example
{
"model": "E-klasse",
"brand": "Mercedes-Benz",
"color": "Черный",
"year": 2019,
"transmission": "automatic",
"vin": "12345678909876543",
"body_number": "123456789",
"mileage": 5000
}
LicencePlateNumber
Государственный регистрационный номер
Type: string
Example: Т8654Т99
RegistrationCertificate
Номер свидетельства о регистрации ТС (Обязательное поле для России)
Type: string
Example: 123456789
LicenceNumber
Номер лицензии на такси
Type: string
Example: 123456789
VehicleLicenses
|
Name |
Description |
|
licence_plate_number |
Type: LicencePlateNumber Государственный регистрационный номер Example: |
|
licence_number |
Type: LicenceNumber Номер лицензии на такси Example: |
|
registration_certificate |
Type: RegistrationCertificate Номер свидетельства о регистрации ТС (Обязательное поле для России) Example: |
Example
{
"licence_plate_number": "Т8654Т99",
"registration_certificate": "123456789",
"licence_number": "123456789"
}
Callsign
Позывной
Type: string
Example: 123456789
Status
Статус ТС. Текущие статусы:
unknown- статус неизвестен;working- в данный момент используется для совершения поездок;not_working- в данный момент не используется для совершения поездок;repairing— подвергается техническому обслуживанию или ремонту;no_driver- за машиной не закреплен водитель;pending- ведется обработка сведений об автомобиле.
Type: string
Example: working
LicenseOwnerId
Идентификатор собственника лицензии
Type: string
Example: 6k054dfdb9i5345ifsdfvpfu8c8cc946
IsParkProperty
Парковая машина
Type: boolean
OwnershipType
Тип собственности
Type: string
Enum: park, leasing
LeasingCompany
Лизинговая компания
Type: string
Example: leasing company
LeasingStartDate
Дата начала лизинга
Type: string
Example: 2022-01-01
LeasingTerm
Срок лизинга (Количество месяцев)
Type: integer
Min value: 0
LeasingMonthlyPayment
Ежемесячный платеж
Type: integer
Min value: 0
LeasingInterestRate
Процентная ставка лизинга
Type: string
Example: 11.7
LeasingConditions
Условия лизинга
|
Name |
Description |
|
company |
Type: LeasingCompany Лизинговая компания Example: |
|
interest_rate |
Type: LeasingInterestRate Процентная ставка лизинга Example: |
|
monthly_payment |
Type: LeasingMonthlyPayment Ежемесячный платеж Min value: Example: |
|
start_date |
Type: LeasingStartDate Дата начала лизинга Example: |
|
term |
Type: LeasingTerm Срок лизинга (Количество месяцев) Min value: Example: |
Example
{
"company": "leasing company",
"start_date": "2022-01-01",
"term": 30,
"monthly_payment": 20000,
"interest_rate": "11.7"
}
Amenities
Удобства в ТС. Допустимые значения:
conditionerno_smokingchild_chairanimal_transportuniversalwificheckcardyamoneynewspapercouponcreditcarddont_callsmokingdeliveryvip_eventwoman_driverpost_terminalbicycleskiingpassenger_pluscargo_cleandoor_to_doorstickerlightbox
Type: string[]
Example
[
"wifi"
]
Categories
Список категорий ТС. Допустимые значения:
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- грузовой.
Type: string[]
Example
[
"econom"
]
Tariff
Тариф парка
Type: string
Example: example
Comment
Описание ТС
Type: string
Example: good car
FuelType
Тип топлива
Type: string
Enum: petrol, methane, propane, electricity
ParkProfile
|
Name |
Description |
|
callsign |
Type: Callsign Позывной Example: |
|
fuel_type |
Type: FuelType Тип топлива Enum: |
|
status |
Type: Status Статус ТС. Текущие статусы:
Example: |
|
amenities |
Type: Amenities Удобства в ТС. Допустимые значения:
Example
|
|
categories |
Type: Categories Список категорий ТС. Допустимые значения:
Example
|
|
comment |
Type: Comment Описание ТС Example: |
|
is_park_property |
Type: IsParkProperty Парковая машина Example: |
|
leasing_conditions |
Type: LeasingConditions Условия лизинга Example
|
|
license_owner_id |
Type: LicenseOwnerId Идентификатор собственника лицензии Example: |
|
ownership_type |
Type: OwnershipType Тип собственности Enum: |
|
tariffs |
Type: Tariffs Список тарифов парка Example
|
Example
{
"callsign": "123456789",
"status": "working",
"license_owner_id": "6k054dfdb9i5345ifsdfvpfu8c8cc946",
"is_park_property": true,
"ownership_type": "park",
"leasing_conditions": {
"company": "leasing company",
"start_date": "2022-01-01",
"term": 30,
"monthly_payment": 20000,
"interest_rate": "11.7"
},
"amenities": [
"wifi"
],
"categories": [
"econom"
],
"tariffs": [
"Комфорт"
],
"comment": "good car",
"fuel_type": "petrol"
}
BoosterCount
Количество бустеров
Type: integer
Min value: 0
Max value: 3
ChildSafety
|
Name |
Description |
|
booster_count |
Type: BoosterCount Количество бустеров Min value: Max value: Example: |
Example
{
"booster_count": 2
}
CargoLoaders
Число грузчиков. Допустимое количество грузчиков от 0 до 2
Type: integer
Min value: 0
CarryingCapacity
Грузоподъемность (в кг). Допустимое значение грузоподъемности от 300 до 6000 кг
Type: integer
Min value: 0
Length
Длина (в см). Допустимое значение длины от 170 до 601 см
Type: integer
Min value: 0
Width
Ширина (в см). Допустимое значение ширины от 96 до 250 см
Type: integer
Min value: 0
Height
Высота (в см). Допустимое значение высоты от 90 до 250 см
Type: integer
Min value: 0
Dimensions
Размеры грузового отсека
|
Name |
Description |
|
height |
Type: Height Высота (в см). Допустимое значение высоты от 90 до 250 см Min value: Example: |
|
length |
Type: Length Длина (в см). Допустимое значение длины от 170 до 601 см Min value: Example: |
|
width |
Type: Width Ширина (в см). Допустимое значение ширины от 96 до 250 см Min value: Example: |
Example
{
"length": 200,
"width": 200,
"height": 150
}
Cargo
|
Name |
Description |
|
cargo_hold_dimensions |
Type: Dimensions Размеры грузового отсека Example
|
|
cargo_loaders |
Type: CargoLoaders Число грузчиков. Допустимое количество грузчиков от 0 до 2 Min value: Example: |
|
carrying_capacity |
Type: CarryingCapacity Грузоподъемность (в кг). Допустимое значение грузоподъемности от 300 до 6000 кг Min value: Example: |
Example
{
"cargo_loaders": 1,
"carrying_capacity": 500,
"cargo_hold_dimensions": {
"length": 200,
"width": 200,
"height": 150
}
}
Responses
200 OK
Создание автомобиля
Body
application/json
{
"vehicle_id": "2111ade6gk054dfdb9iu8c8cc9460mks"
}
|
Name |
Description |
|
vehicle_id |
Type: VehicleId Идентификатор ТС Example: |
VehicleId
Идентификатор ТС
Type: string
Example: 2111ade6gk054dfdb9iu8c8cc9460mks
400 Bad Request
Некорректные параметры запроса
Body
application/json
{
"code": "example",
"message": "Текстовое описание ошибки"
}
|
Name |
Description |
|
message |
Type: string Человекочитаемое сообщение об ошибке Example: |
|
code |
Type: string Машиночитаемый код ошибки Example: |
401 Unauthorized
Отсутствуют параметры авторизации запроса
Body
application/json
{
"code": "example",
"message": "Текстовое описание ошибки"
}
|
Name |
Description |
|
message |
Type: string Человекочитаемое сообщение об ошибке Example: |
|
code |
Type: string Машиночитаемый код ошибки Example: |
403 Forbidden
Недостаточно прав для выполнения запроса
Body
application/json
{
"code": "example",
"message": "Текстовое описание ошибки"
}
|
Name |
Description |
|
message |
Type: string Человекочитаемое сообщение об ошибке Example: |
|
code |
Type: string Машиночитаемый код ошибки Example: |
429 Too Many Requests
Превышено допустимое число запросов
Body
application/json
{
"code": "example",
"message": "Текстовое описание ошибки"
}
|
Name |
Description |
|
message |
Type: string Человекочитаемое сообщение об ошибке Example: |
|
code |
Type: string Машиночитаемый код ошибки Example: |
500 Internal Server Error
Внутренняя ошибка сервера
Body
application/json
{
"code": "example",
"message": "Текстовое описание ошибки"
}
|
Name |
Description |
|
message |
Type: string Человекочитаемое сообщение об ошибке Example: |
|
code |
Type: string Машиночитаемый код ошибки Example: |
No longer supported, please use an alternative and newer version.