Получение списка заявок исполнителей из гаража
Получение списка заявок исполнителей из гаража с пагинацией
Request
GET
https://fleet-api.taxi.yandex.net/v1/parks/contractors/applications/list
Query parameters
|
Name |
Description |
|
cursor |
Type: string Курсор для получения следующий порции данных Example: |
|
date_start |
Type: string<date-time> Начальная дата фильтрации по времени последнего бронирования в формате ISO 8601. Параметр можно передавать только на первой странице (без cursor). Example: |
|
limit |
Type: integer Ограничение количества элементов в ответе Default: Min value: Max value: |
Headers
|
Name |
Description |
|
X-API-Key |
Type: string API-ключ Min length: Example: |
|
X-Client-ID |
Type: string Идентификатор клиента Min length: Example: |
|
X-Park-ID |
Type: string Идентификатор партнера Example: |
|
Accept-Language |
Type: string Предпочитаемый язык ответа. Если не указан, используется ru. Min length: Example: |
Responses
200 OK
Список заявок на автомобили
Body
application/json
{
"items": [
{
"lead_id": "550e8400-e29b-41d4-a716-446655440000",
"driver_id": "33de650c6a1a40bfa78dd981817da866",
"driver_link": "https://fleet.yandex.ru/contractors?park_id=ee6f33c4562b4e1f8646d157bd70b2c4&contractor_id=33de650c6a1a40bfa78dd981817da866",
"driver_name": {
"first_name": "Ivan",
"middle_name": "Ivanovich",
"last_name": "Ivanov"
},
"driver_license": "7700123456",
"phone": "+79999999999",
"vehicle_id": "5011ade6ba054dfdb7143c8cc9460dbc",
"vehicle_brand": "Toyota",
"vehicle_model": "Camry",
"territory_id": "213",
"territory_name": "Москва",
"offer_link": "https://garage.yandex.ru/offer?posting_id=posting_id1&territory_id=213",
"schema": {
"price": "1500.0000",
"working_days": 6,
"non_working_days": 1
},
"request_type": "multiple",
"created_at": "2023-12-15T09:00:00+03:00",
"updated_at": "2023-12-15T14:30:00+03:00"
}
],
"cursor": "eyJsZWFkX2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDAwIn0="
}
|
Name |
Description |
|
items |
Type: ContractorApplicationItem[] Список заявок Example
|
|
cursor |
Type: string Курсор для получения следующей страницы Example: |
FirstName
Имя
Type: string
Example: Ivan
MiddleName
Отчество
Type: string
Example: Ivanovich
LastName
Фамилия
Type: string
Example: Ivanov
FullName
Полное имя водителя
|
Name |
Description |
|
first_name |
Type: FirstName Имя Example: |
|
last_name |
Type: LastName Фамилия Example: |
|
middle_name |
Type: MiddleName Отчество Example: |
Example
{
"first_name": "Ivan",
"middle_name": "Ivanovich",
"last_name": "Ivanov"
}
ContractorApplicationItem
|
Name |
Description |
||||||
|
lead_id |
Type: string<uuid> Идентификатор лида Example: |
||||||
|
phone |
Type: string Номер телефона Example: |
||||||
|
vehicle_id |
Type: string Идентификатор автомобиля Example: |
||||||
|
created_at |
Type: string<date-time> Дата и время создания заявки Example: |
||||||
|
driver_id |
Type: string Идентификатор водителя Example: |
||||||
|
driver_license |
Type: string Номер водительского удостоверения Example: |
||||||
|
driver_link |
Type: string Ссылка на профиль исполнителя или кандидата в Диспетчерской Example: |
||||||
|
driver_name |
Type: FullName Полное имя водителя Example
|
||||||
|
offer_link |
Type: string Ссылка на объявление в гараже Example: |
||||||
|
request_type |
Type: string Тип заявки: phonecall - создана по телефонному звонку, multiple - мультибронирование Enum: |
||||||
|
schema |
Type: object
Схема аренды Example
|
||||||
|
territory_id |
Type: string Идентификатор локации Example: |
||||||
|
territory_name |
Type: string Название локации Example: |
||||||
|
updated_at |
Type: string<date-time> Дата и время обновления заявки Example: |
||||||
|
vehicle_brand |
Type: string Марка автомобиля Example: |
||||||
|
vehicle_model |
Type: string Модель автомобиля Example: |
Example
{
"lead_id": "550e8400-e29b-41d4-a716-446655440000",
"driver_id": "33de650c6a1a40bfa78dd981817da866",
"driver_link": "https://fleet.yandex.ru/contractors?park_id=ee6f33c4562b4e1f8646d157bd70b2c4&contractor_id=33de650c6a1a40bfa78dd981817da866",
"driver_name": {
"first_name": "Ivan",
"middle_name": "Ivanovich",
"last_name": "Ivanov"
},
"driver_license": "7700123456",
"phone": "+79999999999",
"vehicle_id": "5011ade6ba054dfdb7143c8cc9460dbc",
"vehicle_brand": "Toyota",
"vehicle_model": "Camry",
"territory_id": "213",
"territory_name": "Москва",
"offer_link": "https://garage.yandex.ru/offer?posting_id=posting_id1&territory_id=213",
"schema": {
"price": "1500.0000",
"working_days": 6,
"non_working_days": 1
},
"request_type": "multiple",
"created_at": "2023-12-15T09:00:00+03:00",
"updated_at": "2023-12-15T14:30:00+03:00"
}
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: |