Добавляет курьера

Добавляет информацию о курьере в базу данных.

Request

POST

https://courier.yandex.ru/api/v1/companies/{company_id}/couriers

Path parameters

Name

Description

company_id*

Type: integer<int64>

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

Body

application/json

{
    "id": 0,
    "company_id": 0,
    "name": "string",
    "number": "string",
    "phone": "string",
    "sms_enabled": false,
    "allowed_courier_position_sources": [
        "app",
        "gps_tracker"
    ],
    "allow_manual_order_detection": false,
    "allow_manual_depot_detection": false
}

Name	Description
number*	Type: string Номер курьера, совпадающий с номером в учетной системе компании, выполняющей доставку.
allow_manual_depot_detection	Type: boolean Указывает, разрешена ли курьеру ручная детекция посещения складов.
allow_manual_order_detection	Type: boolean Указывает, разрешена ли курьеру ручная детекция посещения заказов.
allowed_courier_position_sources	Type: string[] Список разрешённых источников данных курьерских позиций. Enum: `app`, `gps_tracker`, `s2s_api`, `yanavi` Example: `app,gps_tracker`
company_id	Type: integer<int64> ID компании, используемый в запросах к API Мониторинга.
id	Type: integer ID курьера, используемый в запросах к API Мониторинга.
name	Type: string Имя курьера. Max length: `255`
phone	Type: string Телефон курьера в формате +7XXXXXXXXXX. Для каждого курьера можно указать только один номер телефона.
sms_enabled	Type: boolean Указывает, будут ли клиенты получать SMS-уведомления. Значение `true` означает, что для заказов, доставляемых этим курьером, отправляется SMS-уведомление.

Responses

200 OK

Информация о курьере добавлена в базу данных.

Body

application/json

{
    "id": 0,
    "company_id": 0,
    "name": "string",
    "number": "string",
    "phone": "string",
    "sms_enabled": false,
    "allowed_courier_position_sources": [
        "app",
        "gps_tracker"
    ],
    "allow_manual_order_detection": false,
    "allow_manual_depot_detection": false
}

Name	Description
allow_manual_depot_detection	Type: boolean Указывает, разрешена ли курьеру ручная детекция посещения складов.
allow_manual_order_detection	Type: boolean Указывает, разрешена ли курьеру ручная детекция посещения заказов.
allowed_courier_position_sources	Type: string[] Список разрешённых источников данных курьерских позиций. Enum: `app`, `gps_tracker`, `s2s_api`, `yanavi` Example: `app,gps_tracker`
company_id	Type: integer<int64> ID компании, используемый в запросах к API Мониторинга.
id	Type: integer ID курьера, используемый в запросах к API Мониторинга.
name	Type: string Имя курьера. Max length: `255`
number	Type: string Номер курьера, совпадающий с номером в учетной системе компании, выполняющей доставку.
phone	Type: string Телефон курьера в формате +7XXXXXXXXXX. Для каждого курьера можно указать только один номер телефона.
sms_enabled	Type: boolean Указывает, будут ли клиенты получать SMS-уведомления. Значение `true` означает, что для заказов, доставляемых этим курьером, отправляется SMS-уведомление.

401 Unauthorized

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

422 Unprocessable Entity

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

504 Gateway Timeout

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

Was the article helpful?

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

Редактирует нескольких курьеров