Создание автомобиля

Создание автомобиля

Request

POST

https://fleet-api.taxi.yandex.net/v2/parks/vehicles/car

Headers

Name

Description

X-API-Key

Type: string

API-ключ

Min length: 1

Example: <API-ключ>

X-Client-ID

Type: string

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

Min length: 1

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

X-Idempotency-Token

Type: string

Токен идемпотентности запроса. Должен состоять только из печатных ASCII символов

Min length: 16

Max length: 64

Example: c56fa6537e5a4adbbce6ef3593210fb9

X-Park-ID

Type: string

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

Example: ee6f33c4562b4e1f8646d157bd70b2c4

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
{
  "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"
}

vehicle_licenses

Type: VehicleLicenses

Example
{
  "licence_plate_number": "Т8654Т99",
  "registration_certificate": "123456789",
  "licence_number": "123456789"
}

vehicle_specifications

Type: VehicleSpecifications

Example
{
  "model": "E-klasse",
  "brand": "Mercedes-Benz",
  "color": "Черный",
  "year": 2019,
  "transmission": "automatic",
  "vin": "12345678909876543",
  "body_number": "123456789",
  "mileage": 5000
}

cargo

Type: Cargo

Example
{
  "cargo_loaders": 1,
  "carrying_capacity": 500,
  "cargo_hold_dimensions": {
    "length": 200,
    "width": 200,
    "height": 150
  }
}

child_safety

Type: ChildSafety

Example
{
  "booster_count": 2
}

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: Mercedes-Benz

color

Type: ColorEnum

Цвет ТС

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

model

Type: Model

Модель ТС

Example: E-klasse

transmission

Type: Transmission

Тип коробки передач

Enum: mechanical, automatic, robotic, variator

year

Type: Year

Год выпуска ТС

Example: 2019

body_number

Type: BodyNumber

Номер кузова из СТС ТС

Example: 123456789

mileage

Type: Mileage

Пробег

Min value: 0

Example: 5000

vin

Type: VIN

VIN (Обязательное поле для России)

Example: 12345678909876543

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: Т8654Т99

licence_number

Type: LicenceNumber

Номер лицензии на такси

Example: 123456789

registration_certificate

Type: RegistrationCertificate

Номер свидетельства о регистрации ТС (Обязательное поле для России)

Example: 123456789

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: leasing company

interest_rate

Type: LeasingInterestRate

Процентная ставка лизинга

Example: 11.7

monthly_payment

Type: LeasingMonthlyPayment

Ежемесячный платеж

Min value: 0

Example: 20000

start_date

Type: LeasingStartDate

Дата начала лизинга

Example: 2022-01-01

term

Type: LeasingTerm

Срок лизинга (Количество месяцев)

Min value: 0

Example: 30

Example
{
  "company": "leasing company",
  "start_date": "2022-01-01",
  "term": 30,
  "monthly_payment": 20000,
  "interest_rate": "11.7"
}

Amenities

Удобства в ТС. Допустимые значения:

  • 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

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

Tariffs

Список тарифов парка

Type: Tariff[]

Example
[
  "Комфорт"
]

Comment

Описание ТС

Type: string

Example: good car

FuelType

Тип топлива

Type: string

Enum: petrol, methane, propane, electricity

ParkProfile

Name

Description

callsign

Type: Callsign

Позывной

Example: 123456789

fuel_type

Type: FuelType

Тип топлива

Enum: petrol, methane, propane, electricity

status

Type: Status

Статус ТС. Текущие статусы:

  • unknown - статус неизвестен;
  • working - в данный момент используется для совершения поездок;
  • not_working - в данный момент не используется для совершения поездок;
  • repairing — подвергается техническому обслуживанию или ремонту;
  • no_driver - за машиной не закреплен водитель;
  • pending - ведется обработка сведений об автомобиле.

Example: working

amenities

Type: Amenities

Удобства в ТС. Допустимые значения:

  • 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"
]

categories

Type: 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 - грузовой.
Example
[
  "econom"
]

comment

Type: Comment

Описание ТС

Example: good car

is_park_property

Type: IsParkProperty

Парковая машина

Example: true

leasing_conditions

Type: LeasingConditions

Условия лизинга

Example
{
  "company": "leasing company",
  "start_date": "2022-01-01",
  "term": 30,
  "monthly_payment": 20000,
  "interest_rate": "11.7"
}

license_owner_id

Type: LicenseOwnerId

Идентификатор собственника лицензии

Example: 6k054dfdb9i5345ifsdfvpfu8c8cc946

ownership_type

Type: OwnershipType

Тип собственности

Enum: park, leasing

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: 0

Max value: 3

Example: 2

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: 0

Example: 150

length

Type: Length

Длина (в см). Допустимое значение длины от 170 до 601 см

Min value: 0

Example: 200

width

Type: Width

Ширина (в см). Допустимое значение ширины от 96 до 250 см

Min value: 0

Example: 200

Example
{
  "length": 200,
  "width": 200,
  "height": 150
}

Cargo

Name

Description

cargo_hold_dimensions

Type: Dimensions

Размеры грузового отсека

Example
{
  "length": 200,
  "width": 200,
  "height": 150
}

cargo_loaders

Type: CargoLoaders

Число грузчиков. Допустимое количество грузчиков от 0 до 2

Min value: 0

Example: 1

carrying_capacity

Type: CarryingCapacity

Грузоподъемность (в кг). Допустимое значение грузоподъемности от 300 до 6000 кг

Min value: 0

Example: 500

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: 2111ade6gk054dfdb9iu8c8cc9460mks

VehicleId

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

Type: string

Example: 2111ade6gk054dfdb9iu8c8cc9460mks

400 Bad Request

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

Body

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

401 Unauthorized

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

Body

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

403 Forbidden

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

Body

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

429 Too Many Requests

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

Body

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

500 Internal Server Error

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

Body

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

No longer supported, please use an alternative and newer version.