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

Возвращает список профилей водителей (курьеров), которые прикреплены к определенному партнеру. Рекомендуется использовать как основной метод получения профилей. Ресурс поддерживает создание пагинации и фильтрации. С помощью ресурса можно получить:

все профили водителей (курьеров);
все профили водителей (курьеров) с определенным статусом и условием работы;
конкретные профили водителей (курьеров) по идентификатору.

Request

POST

https://fleet-api.taxi.yandex.net/v1/parks/driver-profiles/list

Headers

Name	Description
Accept-Language*	Type: string Предпочитаемый язык ответа Example: `ru` Min length: `2`
X-API-Key*	Type: string API-ключ Example: `<API-ключ>` Min length: `1`
X-Client-ID*	Type: string Идентификатор клиента Example: `<Идентификатор клиента>` Min length: `1`

Body

application/json

{
    "query": {
        "park": {
            "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
            "driver_profile": {
                "id": [
                    "2111ade6gk054dfdb9iu8c8cc9460mks"
                ],
                "work_rule_id": [
                    "bc43tre6ba054dfdb7143ckfgvcby63e"
                ],
                "work_status": [
                    "working"
                ]
            },
            "current_status": {
                "status": [
                    "free"
                ]
            },
            "account": {
                "last_transaction_date": {
                    "from": "2022-12-29T18:02:01Z",
                    "to": "2022-12-29T18:02:01Z"
                }
            },
            "updated_at": {
                "from": "2022-12-29T18:02:01Z",
                "to": "2022-12-29T18:02:01Z"
            }
        },
        "text": "string"
    },
    "fields": {
        "account": [
            "balance"
        ],
        "car": [
            "color"
        ],
        "current_status": [
            "status"
        ],
        "driver_profile": [
            "last_name"
        ],
        "park": [
            "name"
        ],
        "updated_at": false
    },
    "sort_order": [
        {
            "direction": "asc",
            "field": "driver_profile.created_date"
        }
    ],
    "limit": 200,
    "offset": 0
}

Name	Description
query*	Type: DriverProfilesListRequestQuery Фильтры, объединяются через логическое "И"
fields	Type: DriverProfileListRequestFields Поля профиля, которые необходимо извлечь. Если не указано, то возвращаются все поля профиля. Чтобы исключить определенный блок полей, передайте пустой массив для соответствующего раздела. Например, чтобы исключить информацию об автомобиле, укажите `"car": []`. Пример: `"fields": { "car": [], "park": [], "driver_profile": [ "first_name", "last_name", "id" ], "account": [ "id", "balance", "balance_limit", "currency" ] }`
limit	Type: integer<int32> Запрашиваемое число элементов списка Default: `1000` Example: `200` Min value: `1` Max value: `1000`
offset	Type: integer<int32> Смещение относительно начала списка Default: `0` Example: `0` Min value: `0`
sort_order	Type: DriverProfileRequestSortOrderField[] Массив полей для управления порядком профилей в ответе

DriverProfilesListRequestQuery

Фильтры, объединяются через логическое "И"

Name

Description

park

Type: DriverProfilesListRequestQueryPark

Параметры партнера

text

Type: string

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

DriverProfileListRequestFields

Поля профиля, которые необходимо извлечь. Если не указано, то возвращаются все поля профиля. Чтобы исключить определенный блок полей, передайте пустой массив для соответствующего раздела. Например, чтобы исключить информацию об автомобиле, укажите "car": []. Пример:

"fields": {
    "car": [],
    "park": [],
    "driver_profile": [
        "first_name",
        "last_name",
        "id"
    ],
    "account": [
        "id",
        "balance",
        "balance_limit",
        "currency"
    ]
}

Name	Description
account	Type: string[] Данные счёта, которые необходимо извлечь. Допустимые значения: `id` — идентификатор счета; `type` — тип счета; `balance` — текущий баланс счета; `balance_limit` — текущий лимит; `currency` — код валюты в формате ISO 4217. `last_transaction_date` - дата последней транзакции Example: `balance`
car	Type: VehicleField[] Данные ТС, которые необходимо извлечь. Допустимые значения: `id` — идентификатор; `status` - статус; `amenities` - услуги; `category` - категории; `callsign` - позывной; `brand` — марка; `model` — модель; `year` — год выпуска; `color` - цвет; `number` — регистрационный номер; `registration_cert` - свидетельство о регистрации (СТС); `vin` - идентификационный номер (VIN). Поле ТС Example: `color` Enum: `id`, `status`, `amenities`, `category`, `callsign`, `brand`, `model`, `year`, `color`, `number`, `registration_cert`, `vin`
current_status	Type: string[] Данные о состоянии водителя, которые необходимо извлечь. Допустимые значения: `status` — текущее состояние водителя; `status_updated_at` — время последнего обновления текущего состояния водителя. Example: `status`
driver_profile	Type: string[] Данные профиля водителя, которые необходимо извлечь. Допустимые значения: `id` — идентификатор водительского профиля; `park_id` — идентификатор партнера; `created_date` — дата создания профиля в формате ISO 8601; `first_name` — имя; `last_name` — фамилия; `middle_name` — отчество; `driver_license` — информация о водительском удостоверении; `phones` — телефонные номера; `work_rule_id` — идентификатор условия работы; `work_status` — статус работы водителя; `check_message` - отзыв о водителе; `comment` - прочее; `employment_type` - тип занятости водителя `has_contract_issue` - существуют проблемы с подтверждением занятости. Example: `last_name`
park	Type: string[] Данные партнера, которые необходимо извлечь. Допустимые значения: `id` — идентификатор партнера; `city` — город, в котором расположен партнер; `name` — название партнера. Example: `name`
updated_at	Type: boolean Возвращать ли время последнего обновления

DriverProfileRequestSortOrderField

Name

Description

direction*

Type: string

Направление сортировки. Допустимые значения:

asc — сортировка по возрастанию;
desc — сортировка по убыванию.

Example: asc

Enum: asc, desc

field*

Type: string

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

account.current.balance — баланс;
driver_profile.created_date — дата создания;
driver_profile.last_name — фамилия;
driver_profile.first_name — имя;
driver_profile.middle_name — отчество;
updated_at - время последнего обновления.

Example: driver_profile.created_date

Enum: account.current.balance, driver_profile.created_date, driver_profile.last_name, driver_profile.first_name, driver_profile.middle_name, updated_at

DriverProfilesListRequestQueryPark

Параметры партнера

Name	Description
id*	Type: string Идентификатор партнёра Example: `ee6f33c4562b4e1f8646d157bd70b2c4`
account	Type: DriverProfilesListRequestQueryParkAccount Фильтры по данным счёта
current_status	Type: DriverProfilesListRequestQueryParkCurrentStatus Фильтр по текущему состоянию водителя
driver_profile	Type: DriverProfilesListRequestQueryParkDriverProfile Фильтры по данным водительского профиля
updated_at	Type: DriverProfilesListRequestQueryParkUpdatedAt Фильтры по времени последнего обновления; Полуинтервал времени, хотя бы один конец должен быть указан

VehicleField

Поле ТС

Type

Description

VehicleField

Example: color

Enum: id, status, amenities, category, callsign, brand, model, year, color, number, registration_cert, vin

DriverProfilesListRequestQueryParkAccount

Фильтры по данным счёта

Name

Description

last_transaction_date

Type: DriverProfilesListRequestQueryParkAccountLastTransactionDate

Полуинтервал времени, хотя бы один конец должен быть указан

DriverProfilesListRequestQueryParkCurrentStatus

Фильтр по текущему состоянию водителя

Name

Description

status*

Type: DriverStatus[]

Текущее состояние водителя. Допустимые значения:

offline — оффлайн;
busy — занят;
free — свободен;
in_order_free - на заказе, свободен (цепочка включена);
in_order_busy - на заказе, занят (цепочка выключена).

Example: free

Enum: offline, busy, free, in_order_free, in_order_busy

DriverProfilesListRequestQueryParkDriverProfile

Фильтры по данным водительского профиля

Name	Description
id	Type: string[] Идентификатор профиля водителя Example: `2111ade6gk054dfdb9iu8c8cc9460mks`
work_rule_id	Type: string[] Идентификатор условия работы Example: `bc43tre6ba054dfdb7143ckfgvcby63e`
work_status	Type: WorkStatus[] Статус работы водителя. Допустимые значения: `working` — статус "Работает". `not_working` — статус "Не работает"; `fired` — статус "Уволен"; Example: `working` Enum: `working`, `not_working`, `fired`

DriverProfilesListRequestQueryParkUpdatedAt

Фильтры по времени последнего обновления; Полуинтервал времени, хотя бы один конец должен быть указан

Name

Description

from

Type: string<date-time>

Время от в формате ISO 8601

Type: string<date-time>

Время до в формате ISO 8601

DriverProfilesListRequestQueryParkAccountLastTransactionDate

Полуинтервал времени, хотя бы один конец должен быть указан

Name

Description

from

Type: string<date-time>

Время от в формате ISO 8601

Type: string<date-time>

Время до в формате ISO 8601

DriverStatus

Текущее состояние водителя. Допустимые значения:

offline — оффлайн;
busy — занят;
free — свободен;
in_order_free - на заказе, свободен (цепочка включена);
in_order_busy - на заказе, занят (цепочка выключена).

Type

Description

DriverStatus

Example: free

Enum: offline, busy, free, in_order_free, in_order_busy

WorkStatus

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

working — статус "Работает".
not_working — статус "Не работает";
fired — статус "Уволен";

Type

Description

WorkStatus

Example: working

Enum: working, not_working, fired

Responses

200 OK

Список водительских профилей получен успешно

Body

application/json

{
    "limit": 200,
    "offset": 0,
    "total": 728,
    "driver_profiles": [
        {
            "accounts": [
                {
                    "id": "33de650c6a1a40bfa78dd981817da866",
                    "type": "current",
                    "balance": "700.0000",
                    "balance_limit": "50",
                    "currency": "RUB"
                }
            ],
            "car": {
                "id": "2111ade6gk054dfdb9iu8c8cc9460mks",
                "status": "working",
                "amenities": [
                    [
                        "wifi"
                    ]
                ],
                "category": [
                    [
                        "econom"
                    ]
                ],
                "callsign": "123456789",
                "brand": "Mercedes-Benz",
                "model": "E-klasse",
                "year": 2019,
                "color": "Черный",
                "number": "Т8654Т99",
                "registration_cert": "123456789",
                "vin": "12345678909876543"
            },
            "current_status": {
                "status": "free",
                "status_updated_at": "2020-04-27T08:44:05.871+0000"
            },
            "driver_profile": {
                "id": "2111ade6gk054dfdb9iu8c8cc9460mks",
                "park_id": "ee6f33c4562b4e1f8646d157bd70b2c4",
                "created_date": "2020-04-23T13:08:05.552+0000",
                "last_name": "Ivanov",
                "first_name": "Ivan",
                "middle_name": "Ivanovich",
                "driver_license": {
                    "issue_date": "2020-10-28",
                    "expiration_date": "2050-10-28",
                    "number": "070236",
                    "normalized_number": "AA00123456",
                    "country": "rus",
                    "birth_date": "1975-10-28"
                },
                "phones": [
                    "+79999999999"
                ],
                "work_rule_id": "bc43tre6ba054dfdb7143ckfgvcby63e",
                "work_status": "working",
                "check_message": "great driver",
                "comment": "great driver",
                "employment_type": "selfemployed",
                "has_contract_issue": false
            }
        }
    ],
    "parks": [
        {
            "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
            "city": "Москва",
            "name": "Рога и Копыта"
        }
    ]
}

Name	Description
driver_profiles*	Type: DriverProfile[] Список профилей
limit*	Type: integer<int32> Запрошённое число элементов списка Example: `200`
offset*	Type: integer<int32> Запрошённое смещение относительно начала списка Example: `0`
parks*	Type: DriverProfilePark[] Список партнеров
total*	Type: integer<int32> Общее количество элементов списка Example: `728`

DriverProfile

Name	Description
accounts	Type: DriverProfileAccount[] Список счетов, которые связаны с водителем. Информация о счете
car	Type: Vehicle Данные ТС
current_status	Type: DriverProfileCurrentStatus
driver_profile	Type: DriverProfileModel Профиль водителя

DriverProfilePark

Name	Description
city	Type: string Город партнера Example: `Москва`
id	Type: string Идентификатор партнёра Example: `ee6f33c4562b4e1f8646d157bd70b2c4`
name	Type: string Название партнера Example: `Рога и Копыта`

DriverProfileAccount

Информация о счете

Name	Description
balance	Type: string Текущий баланс (сумма с фиксированной точностью) Example: `700.0000`
balance_limit	Type: string Лимит по счету Example: `50`
currency	Type: string Валюта в формате ISO 4217 Example: `RUB`
id	Type: string Идентификатор счета Example: `33de650c6a1a40bfa78dd981817da866`
type	Type: AccountType Тип счета. Допустимые значения: `current` - текущий счёт. Example: `current` Enum: `current`

Vehicle

Данные ТС

Name	Description
id*	Type: string Идентификатор ТС Example: `2111ade6gk054dfdb9iu8c8cc9460mks`
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`
brand	Type: string Марка ТС Example: `Mercedes-Benz`
callsign	Type: string Позывной Example: `123456789`
category	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`
color	Type: ColorEnum Цвет ТС Example: `Черный` Enum: `Белый`, `Желтый`, `Бежевый`, `Черный`, `Голубой`, `Серый`, `Красный`, `Оранжевый`, `Синий`, `Зеленый`, `Коричневый`, `Фиолетовый`, `Розовый`
model	Type: string Модель ТС Example: `E-klasse`
number	Type: string Государственный регистрационный номер Example: `Т8654Т99`
registration_cert	Type: string Номер свидетельства о регистрации ТС (Обязательное поле для России) Example: `123456789`
status	Type: string Статус ТС. Текущие статусы: `unknown` - статус неизвестен; `working` - в данный момент используется для совершения поездок; `not_working` - в данный момент не используется для совершения поездок; `repairing` — подвергается техническому обслуживанию или ремонту; `no_driver` - за машиной не закреплен водитель; `pending` - ведется обработка сведений об автомобиле. Example: `working`
vin	Type: string VIN (Обязательное поле для России) Example: `12345678909876543`
year	Type: integer Год выпуска ТС Example: `2019`

DriverProfileCurrentStatus

Name

Description

status

Type: DriverStatus

Текущее состояние водителя. Допустимые значения:

offline — оффлайн;
busy — занят;
free — свободен;
in_order_free - на заказе, свободен (цепочка включена);
in_order_busy - на заказе, занят (цепочка выключена).

Example: free

Enum: offline, busy, free, in_order_free, in_order_busy

status_updated_at

Type: string

Время последнего обновления текущего состояния водителя в формате ISO 8601.

Example: 2020-04-27T08:44:05.871+0000

DriverProfileModel

Профиль водителя

Name	Description
check_message	Type: string Прочее (доступно сотрудникам парка) Example: `great driver`
comment	Type: string Прочее Example: `great driver`
created_date	Type: string Дата создания профиля в формате ISO 8601 Example: `2020-04-23T13:08:05.552+0000`
driver_license	Type: object Водительское удостоверение
employment_type	Type: EmploymentType Тип занятости водителя. Допустимые значения: `selfemployed` — Парковый самозанятый; `park_employee` — Парковый исполнитель; `individual_entrepreneur` — Индивидуальный предприниматель; Example: `selfemployed` Enum: `selfemployed`, `park_employee`, `individual_entrepreneur`
first_name	Type: string Имя Example: `Ivan`
has_contract_issue	Type: boolean Существуют проблемы с подтверждением занятости
id	Type: string Идентификатор профиля водителя Example: `2111ade6gk054dfdb9iu8c8cc9460mks`
last_name	Type: string Фамилия Example: `Ivanov`
middle_name	Type: string Отчество Example: `Ivanovich`
park_id	Type: string Идентификатор партнёра Example: `ee6f33c4562b4e1f8646d157bd70b2c4`
phones	Type: string[] Номер телефона Example: `+79999999999` Pattern: `^\+\d{1,15}$`
work_rule_id	Type: string Идентификатор условия работы Example: `bc43tre6ba054dfdb7143ckfgvcby63e`
work_status	Type: WorkStatus Статус работы водителя. Допустимые значения: `working` — статус "Работает". `not_working` — статус "Не работает"; `fired` — статус "Уволен"; Example: `working` Enum: `working`, `not_working`, `fired`

AccountType

Тип счета. Допустимые значения:

current - текущий счёт.

Type

Description

AccountType

Example: current

Enum: current

ColorEnum

Цвет ТС

Type

Description

ColorEnum

Example: Черный

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

EmploymentType

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

selfemployed — Парковый самозанятый;
park_employee — Парковый исполнитель;
individual_entrepreneur — Индивидуальный предприниматель;

Type

Description

EmploymentType

Example: selfemployed

Enum: selfemployed, park_employee, individual_entrepreneur

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

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

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

Привязка автомобиля к водителю (курьеру)

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