Создание профиля авто курьера
Создание профиля авто курьера
HTTP-запрос
POST https://fleet-api.taxi.yandex.net/v2/parks/contractors/auto-courier-profile
Заголовки запроса
X-Idempotency-Token * | string Токен идемпотентности запроса, |
X-Client-ID * | string Идентификатор клиента |
X-API-Key * | string API-ключ |
X-Park-ID * | string Идентификатор партнера |
* Обязательный параметр
Тело запроса
{ "account": { "balance_limit": "50", "block_orders_on_balance_below_limit": false, "payment_service_id": "12345", "work_rule_id": "bc43tre6ba054dfdb7143ckfgvcby63e" }, "car_id": "5011ade6ba054dfdb7143c8cc9460dbc", "order_provider": { "partner": false, "platform": true }, "person": { "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" }, "full_name": { "first_name": "Ivan", "last_name": "Ivanov", "middle_name": "Ivanovich" }, "tax_identification_number": "7743013902" }, "profile": { "comment": "great driver", "hire_date": "2020-10-28" } }
Скопировано
Представление
Поля
account | object Учетная запись водителя |
account. | string Лимит по счету |
account. | boolean Запрещены ли все заказы при балансе ниже лимита |
account. | string ID для платежа (будет сгенерировано автоматически, если оставить это поле пустым) |
account. | string Идентификатор условия работы |
car_id | string Идентификатор автомобиля |
order_provider * | object |
order_provider. | boolean Доступны ли заказы от партнера |
order_provider. | boolean Доступны ли заказы от платформы |
person * | object Персональные данные водителя |
person. | object Контактная информация водителя |
person. | string Адрес |
person. | string Электронная почта |
person. | string Номер телефона |
person. | object Информация o водительском удостоверении |
person. | string Дата рождения в формате ISO 8601 без временной зоны |
person. | string Страна выдачи водительского удостоверения (Трехбуквенный код) |
person. | string Дата окончания действия водительского удостоверения в формате ISO 8601 без временной зоны |
person. | string Дата выдачи водительского удостоверения в формате ISO 8601 без временной зоны |
person. | string Серия и номер водительского удостоверения |
person. | object Водительский стаж c |
person. | string Дата в формате ISO 8601 без временной зоны |
person. | object Полное имя водителя |
person. | string Имя |
person. | string Фамилия |
person. | string Отчество |
person. | string Идентификационный номер налогоплательщика |
profile * | object |
profile. | string Прочее |
profile. | string Дата приема в парк в формате ISO 8601 без временной зоны |
account | object Учетная запись водителя |
account. | string Лимит по счету |
account. | boolean Запрещены ли все заказы при балансе ниже лимита |
account. | string ID для платежа (будет сгенерировано автоматически, если оставить это поле пустым) |
account. | string Идентификатор условия работы |
car_id | string Идентификатор автомобиля |
order_provider * | object |
order_provider. | boolean Доступны ли заказы от партнера |
order_provider. | boolean Доступны ли заказы от платформы |
person * | object Персональные данные водителя |
person. | object Контактная информация водителя |
person. | string Адрес |
person. | string Электронная почта |
person. | string Номер телефона |
person. | object Информация o водительском удостоверении |
person. | string Дата рождения в формате ISO 8601 без временной зоны |
person. | string Страна выдачи водительского удостоверения (Трехбуквенный код) |
person. | string Дата окончания действия водительского удостоверения в формате ISO 8601 без временной зоны |
person. | string Дата выдачи водительского удостоверения в формате ISO 8601 без временной зоны |
person. | string Серия и номер водительского удостоверения |
person. | object Водительский стаж c |
person. | string Дата в формате ISO 8601 без временной зоны |
person. | object Полное имя водителя |
person. | string Имя |
person. | string Фамилия |
person. | string Отчество |
person. | string Идентификационный номер налогоплательщика |
profile * | object |
profile. | string Прочее |
profile. | string Дата приема в парк в формате ISO 8601 без временной зоны |
* Обязательный параметр
Ответы
Код 200
Создание профиля водителя
{ "contractor_profile_id": "2111ade6gk054dfdb9iu8c8cc9460mks" }
Скопировано
Представление
Поля
contractor_profile_id * | string Идентификатор профиля водителя |
contractor_profile_id * | string Идентификатор профиля водителя |
* Обязательный параметр
Код 400
Некорректные параметры запроса
{ "code": "string", "message": "Текстовое описание ошибки" }
Скопировано
Представление
Поля
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
* Обязательный параметр
Код 429
Превышено допустимое число запросов
{ "code": "string", "message": "Текстовое описание ошибки" }
Скопировано
Представление
Поля
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
* Обязательный параметр
Код 500
Внутренняя ошибка сервера
{ "code": "string", "message": "Текстовое описание ошибки" }
Скопировано
Представление
Поля
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
* Обязательный параметр
Пример
Request:
curl -X POST "https://fleet-api.taxi.yandex.net/v2/parks/contractors/auto-courier-profile" \ -H "X-Idempotency-Token: c56fa6537e5a4adbbce6ef3593210fb9" \ -H "X-Client-ID: <Идентификатор клиента>" \ -H "X-API-Key: <API-ключ>" \ -H "X-Park-ID: ee6f33c4562b4e1f8646d157bd70b2c4" \ -d '{ "account": { "balance_limit": "50", "block_orders_on_balance_below_limit": false, "payment_service_id": "12345", "work_rule_id": "bc43tre6ba054dfdb7143ckfgvcby63e" }, "car_id": "5011ade6ba054dfdb7143c8cc9460dbc", "order_provider": { "partner": false, "platform": true }, "person": { "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" }, "full_name": { "first_name": "Ivan", "last_name": "Ivanov", "middle_name": "Ivanovich" }, "tax_identification_number": "7743013902" }, "profile": { "comment": "great driver", "hire_date": "2020-10-28" } }'
Скопировано
Responses:
{ "contractor_profile_id": "2111ade6gk054dfdb9iu8c8cc9460mks" }
Скопировано
{ "message": "Текстовое описание ошибки" }
Скопировано
{ "message": "Текстовое описание ошибки" }
Скопировано
{ "message": "Текстовое описание ошибки" }
Скопировано