Создание профиля исполнителя с указанием типа сотрудничества

Для индивидуального предпринимателя возможна только профессия водитель такси.

Request

POST

https://fleet-api.taxi.yandex.net/v1/parks/contractors/profile

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

{
  "contractor": {
    "account": {
      "balance_limit": "50",
      "work_rule_id": "bc43tre6ba054dfdb7143ckfgvcby63e",
      "payment_service_id": "12345",
      "block_orders_on_balance_below_limit": true
    },
    "person": {
      "full_name": {
        "first_name": "Ivan",
        "middle_name": "Ivanovich",
        "last_name": "Ivanov"
      },
      "contact_info": {
        "address": "Moscow, Ivanovskaya Ul., bld. 40/2, appt. 63",
        "email": "example-email@example.com",
        "phone": "+79999999999"
      },
      "driver_license": {
        "birth_date": "1975-10-28",
        "country": "rus",
        "expiry_date": "2050-10-28",
        "issue_date": "2020-10-28",
        "number": "070236"
      },
      "driver_license_experience": {
        "total_since_date": "1970-01-01"
      },
      "id_doc": {
        "address": "example"
      },
      "tax_identification_number": "7743013902"
    },
    "profile": {
      "hire_date": "2020-10-28",
      "comment": "great driver"
    },
    "car_id": "5011ade6ba054dfdb7143c8cc9460dbc",
    "order_provider": {
      "platform": true,
      "partner": true
    }
  },
  "profession": "taxi/driver",
  "employment": {
    "type": "park_employee"
  }
}

Name	Description
contractor	Type: ContractorFields Основные поля исполнителя Example { "account": { "balance_limit": "50", "work_rule_id": "bc43tre6ba054dfdb7143ckfgvcby63e", "payment_service_id": "12345", "block_orders_on_balance_below_limit": true }, "person": { "full_name": { "first_name": "Ivan", "middle_name": "Ivanovich", "last_name": "Ivanov" }, "contact_info": { "address": "Moscow, Ivanovskaya Ul., bld. 40/2, appt. 63", "email": "example-email@example.com", "phone": "+79999999999" }, "driver_license": { "birth_date": "1975-10-28", "country": "rus", "expiry_date": "2050-10-28", "issue_date": "2020-10-28", "number": "070236" }, "driver_license_experience": { "total_since_date": "1970-01-01" }, "id_doc": { "address": "example" }, "tax_identification_number": "7743013902" }, "profile": { "hire_date": "2020-10-28", "comment": "great driver" }, "car_id": "5011ade6ba054dfdb7143c8cc9460dbc", "order_provider": { "platform": true, "partner": true } }
employment	Type: Employment Информация о сотрудничестве исполнителя Example `{ "type": "park_employee" }`
profession	Type: Profession Профессия исполнителя. Допустимые значения: `taxi/driver` — Водитель такси; `cargo/courier/on-car` — Курьер на автомобиле; `cargo/courier/on-truck` — Водитель на грузовом авто; Enum: `taxi/driver`, `cargo/courier/on-car`, `cargo/courier/on-truck`

BalanceLimit

Лимит по счету

Type: string

Example: 50

WorkRuleId

Идентификатор условия работы

Type: string

Example: bc43tre6ba054dfdb7143ckfgvcby63e

PaymentServiceId

ID для платежа (будет сгенерировано автоматически, если оставить это поле пустым)

Type: string

Example: 12345

BlockOrdersOnBalanceBelowLimit

Запрещены ли все заказы при балансе ниже лимита

Type: boolean

Account

Учетная запись водителя

Name	Description
balance_limit	Type: BalanceLimit Лимит по счету Example: `50`
block_orders_on_balance_below_limit	Type: BlockOrdersOnBalanceBelowLimit Запрещены ли все заказы при балансе ниже лимита Example: `true`
work_rule_id	Type: WorkRuleId Идентификатор условия работы Example: `bc43tre6ba054dfdb7143ckfgvcby63e`
payment_service_id	Type: PaymentServiceId ID для платежа (будет сгенерировано автоматически, если оставить это поле пустым) Example: `12345`

Example

{
  "balance_limit": "50",
  "work_rule_id": "bc43tre6ba054dfdb7143ckfgvcby63e",
  "payment_service_id": "12345",
  "block_orders_on_balance_below_limit": true
}

FirstName

Имя

Type: string

Example: Ivan

MiddleName

Отчество

Type: string

Example: Ivanovich

LastName

Фамилия

Type: string

Example: Ivanov

FullName

Полное имя водителя

Name	Description
first_name	Type: FirstName Имя Example: `Ivan`
last_name	Type: LastName Фамилия Example: `Ivanov`
middle_name	Type: MiddleName Отчество Example: `Ivanovich`

Example

{
  "first_name": "Ivan",
  "middle_name": "Ivanovich",
  "last_name": "Ivanov"
}

Address

Адрес

Type: string

Example: Moscow, Ivanovskaya Ul., bld. 40/2, appt. 63

Email

Электронная почта

Type: string

Example: example-email@example.com

Phone

Номер телефона

Type: string

Pattern: ^\+\d{1,15}$

Example: +79999999999

ContactInfo

Контактная информация водителя

Name	Description
phone	Type: Phone Номер телефона Pattern: `^\+\d{1,15}$` Example: `+79999999999`
address	Type: Address Адрес Example: `Moscow, Ivanovskaya Ul., bld. 40/2, appt. 63`
email	Type: Email Электронная почта Example: `example-email@example.com`

Example

{
  "address": "Moscow, Ivanovskaya Ul., bld. 40/2, appt. 63",
  "email": "example-email@example.com",
  "phone": "+79999999999"
}

BirthDate

Дата рождения в формате ISO 8601 без временной зоны

Type: string

Example: 1975-10-28

CountryCode

Страна выдачи водительского удостоверения (Трехбуквенный код)

Type: string

Example: rus

ExpiryDate

Дата окончания действия водительского удостоверения в формате ISO 8601 без временной зоны

Type: string

Example: 2050-10-28

IssueDate

Дата выдачи водительского удостоверения в формате ISO 8601 без временной зоны

Type: string

Example: 2020-10-28

Number

Серия и номер водительского удостоверения

Type: string

Example: 070236

DriverLicense

Информация o водительском удостоверении

Name	Description
country	Type: CountryCode Страна выдачи водительского удостоверения (Трехбуквенный код) Example: `rus`
expiry_date	Type: ExpiryDate Дата окончания действия водительского удостоверения в формате ISO 8601 без временной зоны Example: `2050-10-28`
issue_date	Type: IssueDate Дата выдачи водительского удостоверения в формате ISO 8601 без временной зоны Example: `2020-10-28`
number	Type: Number Серия и номер водительского удостоверения Example: `070236`
birth_date	Type: BirthDate Дата рождения в формате ISO 8601 без временной зоны Example: `1975-10-28`

Example

{
  "birth_date": "1975-10-28",
  "country": "rus",
  "expiry_date": "2050-10-28",
  "issue_date": "2020-10-28",
  "number": "070236"
}

Date

Дата в формате ISO 8601 без временной зоны

Type: string

Example: 1970-01-01

DriverLicenseExperience

Водительский стаж c

Name

Description

total_since_date

Type: Date

Дата в формате ISO 8601 без временной зоны

Example: 1970-01-01

Example

{
  "total_since_date": "1970-01-01"
}

IdDoc

Паспортные данные

Name

Description

address

Type: string

Адрес регистрации

Example: example

Example

{
  "address": "example"
}

TaxIdentificationNumber

Идентификационный номер налогоплательщика

Type: string

Min length: 1

Example: 7743013902

Person

Персональные данные водителя

Name	Description
contact_info	Type: ContactInfo Контактная информация водителя Example `{ "address": "Moscow, Ivanovskaya Ul., bld. 40/2, appt. 63", "email": "example-email@example.com", "phone": "+79999999999" }`
driver_license	Type: DriverLicense Информация o водительском удостоверении Example `{ "birth_date": "1975-10-28", "country": "rus", "expiry_date": "2050-10-28", "issue_date": "2020-10-28", "number": "070236" }`
full_name	Type: FullName Полное имя водителя Example `{ "first_name": "Ivan", "middle_name": "Ivanovich", "last_name": "Ivanov" }`
driver_license_experience	Type: DriverLicenseExperience Водительский стаж c Example `{ "total_since_date": "1970-01-01" }`
id_doc	Type: IdDoc Паспортные данные Example `{ "address": "example" }`
tax_identification_number	Type: TaxIdentificationNumber Идентификационный номер налогоплательщика Min length: `1` Example: `7743013902`

Example

{
  "full_name": {
    "first_name": "Ivan",
    "middle_name": "Ivanovich",
    "last_name": "Ivanov"
  },
  "contact_info": {
    "address": "Moscow, Ivanovskaya Ul., bld. 40/2, appt. 63",
    "email": "example-email@example.com",
    "phone": "+79999999999"
  },
  "driver_license": {
    "birth_date": "1975-10-28",
    "country": "rus",
    "expiry_date": "2050-10-28",
    "issue_date": "2020-10-28",
    "number": "070236"
  },
  "driver_license_experience": {
    "total_since_date": "1970-01-01"
  },
  "id_doc": {
    "address": "example"
  },
  "tax_identification_number": "7743013902"
}

HireDate

Дата приема в парк в формате ISO 8601 без временной зоны

Type: string

Example: 2020-10-28

Comment

Прочее

Type: string

Example: great driver

Profile

Name

Description

hire_date

Type: HireDate

Дата приема в парк в формате ISO 8601 без временной зоны

Example: 2020-10-28

comment

Type: Comment

Прочее

Example: great driver

Example

{
  "hire_date": "2020-10-28",
  "comment": "great driver"
}

CarId

Идентификатор автомобиля

Type: string

Min length: 1

Max length: 100

Example: 5011ade6ba054dfdb7143c8cc9460dbc

Platform

Доступны ли заказы от платформы

Type: boolean

Partner

Доступны ли заказы от партнера

Type: boolean

OrderProvider

Name

Description

partner

Type: Partner

Доступны ли заказы от партнера

Example: true

platform

Type: Platform

Доступны ли заказы от платформы

Example: true

Example

{
  "platform": true,
  "partner": true
}

ContractorFields

Основные поля исполнителя

Name	Description
order_provider	Type: OrderProvider Example `{ "platform": true, "partner": true }`
person	Type: Person Персональные данные водителя Example { "full_name": { "first_name": "Ivan", "middle_name": "Ivanovich", "last_name": "Ivanov" }, "contact_info": { "address": "Moscow, Ivanovskaya Ul., bld. 40/2, appt. 63", "email": "example-email@example.com", "phone": "+79999999999" }, "driver_license": { "birth_date": "1975-10-28", "country": "rus", "expiry_date": "2050-10-28", "issue_date": "2020-10-28", "number": "070236" }, "driver_license_experience": { "total_since_date": "1970-01-01" }, "id_doc": { "address": "example" }, "tax_identification_number": "7743013902" }
profile	Type: Profile Example `{ "hire_date": "2020-10-28", "comment": "great driver" }`
account	Type: Account Учетная запись водителя Example `{ "balance_limit": "50", "work_rule_id": "bc43tre6ba054dfdb7143ckfgvcby63e", "payment_service_id": "12345", "block_orders_on_balance_below_limit": true }`
car_id	Type: CarId Идентификатор автомобиля Min length: `1` Max length: `100` Example: `5011ade6ba054dfdb7143c8cc9460dbc`

Example

{
  "account": {
    "balance_limit": "50",
    "work_rule_id": "bc43tre6ba054dfdb7143ckfgvcby63e",
    "payment_service_id": "12345",
    "block_orders_on_balance_below_limit": true
  },
  "person": {
    "full_name": {
      "first_name": "Ivan",
      "middle_name": "Ivanovich",
      "last_name": "Ivanov"
    },
    "contact_info": {
      "address": "Moscow, Ivanovskaya Ul., bld. 40/2, appt. 63",
      "email": "example-email@example.com",
      "phone": "+79999999999"
    },
    "driver_license": {
      "birth_date": "1975-10-28",
      "country": "rus",
      "expiry_date": "2050-10-28",
      "issue_date": "2020-10-28",
      "number": "070236"
    },
    "driver_license_experience": {
      "total_since_date": "1970-01-01"
    },
    "id_doc": {
      "address": "example"
    },
    "tax_identification_number": "7743013902"
  },
  "profile": {
    "hire_date": "2020-10-28",
    "comment": "great driver"
  },
  "car_id": "5011ade6ba054dfdb7143c8cc9460dbc",
  "order_provider": {
    "platform": true,
    "partner": true
  }
}

Profession

Профессия исполнителя. Допустимые значения:

taxi/driver — Водитель такси;
cargo/courier/on-car — Курьер на автомобиле;
cargo/courier/on-truck — Водитель на грузовом авто;

Type: string

Enum: taxi/driver, cargo/courier/on-car, cargo/courier/on-truck

ParkEmployee

Парковый исполнитель

Name

Description

type

Type: string

Const: park_employee

Example: example

Example

{
  "type": "park_employee"
}

SelfemployedRus

Самозанятый в Российской Федерации

Name

Description

phone

Type: string

Min length: 1

Example: example

type

Type: string

Const: selfemployed

Example: example

Example

{
  "type": "selfemployed",
  "phone": "example"
}

TaxSystemRus

Система налогообложения ИП.

OSN - общая система налогообложения (ОСН/ОСНО)
USN - упрощенная система налогообложения (УСН)
AUSN - автоматизированная упрощенная система налогообложения (АУСН)
OSNP - патентная система налогообложения (ОСН)
USNP - патентная система налогообложения (УСН)

Type: string

Enum: OSN, USN, AUSN, OSNP, USNP

IndividualEntrepreneurRus

Индивидуальный предприниматель в Российской Федерации

Также обязательным является наличие contractor.person.id_doc.address

Name

Description

tax_system

Type: TaxSystemRus

Система налогообложения ИП.

OSN - общая система налогообложения (ОСН/ОСНО)
USN - упрощенная система налогообложения (УСН)
AUSN - автоматизированная упрощенная система налогообложения (АУСН)
OSNP - патентная система налогообложения (ОСН)
USNP - патентная система налогообложения (УСН)

Enum: OSN, USN, AUSN, OSNP, USNP

type

Type: string

Const: individual_entrepreneur

Example: example

Example

{
  "type": "individual_entrepreneur",
  "tax_system": "OSN"
}

IndividualEntrepreneurKaz

Индивидуальный предприниматель в Казахстане

Name	Description
phone	Type: string Min length: `1` Example: `example`
tax_authority_code	Type: string Min length: `1` Example: `example`
type	Type: string Const: `individual_entrepreneur` Example: `example`

Example

{
  "type": "individual_entrepreneur",
  "phone": "example",
  "tax_authority_code": "example"
}

Employment

Информация о сотрудничестве исполнителя

One of 4 types

Type: ParkEmployee

Парковый исполнитель
Example
```
{
  "type": "park_employee"
}
```
Type: SelfemployedRus

Самозанятый в Российской Федерации
Example
```
{
  "type": "selfemployed",
  "phone": "example"
}
```
Type: IndividualEntrepreneurRus

Индивидуальный предприниматель в Российской Федерации

Также обязательным является наличие contractor.person.id_doc.address
Example
```
{
  "type": "individual_entrepreneur",
  "tax_system": "OSN"
}
```
Type: IndividualEntrepreneurKaz

Индивидуальный предприниматель в Казахстане
Example
```
{
  "type": "individual_entrepreneur",
  "phone": "example",
  "tax_authority_code": "example"
}
```

Example

{
  "type": "park_employee"
}

Responses

200 OK

Создание профиля водителя

Body

application/json

{
  "contractor_profile_id": "2111ade6gk054dfdb9iu8c8cc9460mks"
}

Name

Description

contractor_profile_id

Type: ContractorProfileId

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

Example: 2111ade6gk054dfdb9iu8c8cc9460mks

ContractorProfileId

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

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

Была ли статья полезна?

Получение списка профилей водителей (курьеров)

Получение профиля водителя (курьера)