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

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

Request

POST

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

Headers

Name

Description

X-API-Key*

Type: string

API-ключ

Example: <API-ключ>

Min length: 1

X-Client-ID*

Type: string

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

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

Min length: 1

X-Idempotency-Token*

Type: string

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

Example: c56fa6537e5a4adbbce6ef3593210fb9

Min length: 16

Max length: 64

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": false,
        "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

vehicle_licenses*

Type: VehicleLicenses

vehicle_specifications*

Type: VehicleSpecifications

cargo

Type: Cargo

child_safety

Type: ChildSafety

ParkProfile

Name

Description

callsign*

Type: string

Позывной

Example: 123456789

fuel_type*

Type: FuelType

Тип топлива

Enum: petrol, methane, propane, electricity

status*

Type: string

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

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

Example: working

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

comment

Type: string

Описание ТС

Example: good car

is_park_property

Type: boolean

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

leasing_conditions

Type: LeasingConditions

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

license_owner_id

Type: string

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

Example: 6k054dfdb9i5345ifsdfvpfu8c8cc946

ownership_type

Type: OwnershipType

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

Example: park

Enum: park, leasing

tariffs

Type: string[]

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

Example: Комфорт

VehicleLicenses

Name

Description

licence_plate_number*

Type: string

Государственный регистрационный номер

Example: Т8654Т99

licence_number

Type: string

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

Example: 123456789

registration_certificate

Type: string

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

Example: 123456789

VehicleSpecifications

Name

Description

brand*

Type: string

Марка ТС

Example: Mercedes-Benz

color*

Type: ColorEnum

Цвет ТС

Example: Черный

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

model*

Type: string

Модель ТС

Example: E-klasse

transmission*

Type: Transmission

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

Example: automatic

Enum: mechanical, automatic, robotic, variator

year*

Type: integer

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

Example: 2019

body_number

Type: string

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

Example: 123456789

mileage

Type: integer

Пробег

Example: 5000

Min value: 0

vin

Type: string

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

Example: 12345678909876543

Cargo

Name

Description

cargo_hold_dimensions

Type: Dimensions

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

cargo_loaders

Type: integer

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

Example: 1

Min value: 0

carrying_capacity

Type: integer

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

Example: 500

Min value: 0

ChildSafety

Name

Description

booster_count*

Type: integer

Количество бустеров

Example: 2

Min value: 0

Max value: 3

FuelType

Тип топлива

Type

Description

FuelType

Enum: petrol, methane, propane, electricity

LeasingConditions

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

Name

Description

company*

Type: string

Лизинговая компания

Example: leasing company

interest_rate*

Type: string

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

Example: 11.7

monthly_payment*

Type: integer

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

Example: 20000

Min value: 0

start_date*

Type: string

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

Example: 2022-01-01

term*

Type: integer

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

Example: 30

Min value: 0

OwnershipType

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

Type

Description

OwnershipType

Example: park

Enum: park, leasing

ColorEnum

Цвет ТС

Type

Description

ColorEnum

Example: Черный

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

Transmission

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

Type

Description

Transmission

Example: automatic

Enum: mechanical, automatic, robotic, variator

Dimensions

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

Name

Description

height*

Type: integer

Высота (в см). Допустимое значение высоты от 90 до 250 см

Example: 150

Min value: 0

length*

Type: integer

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

Example: 200

Min value: 0

width*

Type: integer

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

Example: 200

Min value: 0

Responses

200 OK

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

Body

application/json
{
    "vehicle_id": "2111ade6gk054dfdb9iu8c8cc9460mks"
}

Name

Description

vehicle_id*

Type: string

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

Example: 2111ade6gk054dfdb9iu8c8cc9460mks

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

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