Получает курьера

Возвращает информацию о курьерах по их номерам.

HTTP-запрос

GET https://courier.yandex.ru/api/v1/companies/{company_id}/couriers\
?number={string}\
&page={integer}

Path-параметры

company_id *

integer

ID компании, используемый в запросах к API Мониторинга.

* Обязательный параметр

Query-параметры

number	string Уникальный номер курьера, совпадающий с номером в базе данных компании, выполняющей доставку.
page	integer Номер страницы в базе данных. Каждая страница содержит 1000 курьеров, организованных в порядке возрастания ID курьера. Минимальное значение: `1`. Значение по умолчанию: `1`.

* Обязательный параметр

Ответы

Код 200

Список курьеров получен.

[
  {
    "allow_manual_depot_detection": boolean,
    "allow_manual_order_detection": boolean,
    "allowed_courier_position_sources": [
      string
    ],
    "company_id": integer,
    "id": integer,
    "name": string,
    "number": string,
    "phone": string,
    "sms_enabled": boolean
  }
]
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

allow_manual_depot_detection	boolean Указывает, разрешена ли курьеру ручная детекция посещения складов.
allow_manual_order_detection	boolean Указывает, разрешена ли курьеру ручная детекция посещения заказов.
allowed_courier_position_sources[]	array Список разрешённых источников данных курьерских позиций.
company_id	integer ID компании, используемый в запросах к API Мониторинга.
id	integer ID курьера, используемый в запросах к API Мониторинга.
name	string Имя курьера.
number *	string Номер курьера, совпадающий с номером в учетной системе компании, выполняющей доставку.
phone	string Телефон курьера в формате +7XXXXXXXXXX. Для каждого курьера можно указать только один номер телефона.
sms_enabled	boolean Указывает, будут ли клиенты получать SMS-уведомления. Значение `true` означает, что для заказов, доставляемых этим курьером, отправляется SMS-уведомление.

* Обязательный параметр

Код 401

Ошибка авторизации. Убедитесь, что заголовок запроса содержит правильный OAuth-токен.

Код 403

У вас нет доступа к этому объекту.

Код 422

Неверный ввод. Операция не может быть выполнена.

Код 504

Ошибка при работе с API. Повторите запрос.