---
metadata:
  - name: generator
    content: Diplodoc Platform v5.52.0
alternate:
  - https://yandex.kz/routing/doc/en/delivery/functions/custom-fields.md
  - https://yandex.kz/routing/doc/kk/delivery/functions/custom-fields.md
  - https://yandex.kz/routing/doc/ru/delivery/functions/custom-fields.md
  - href: kk/delivery/functions/custom-fields.md
    type: text/markdown
    title: Markdown version
  - href: ../llms.txt
    type: text/markdown
    title: llms.txt
title: Яндекс Маршрутизация — функции — пользовательские поля маршрута
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.kz/routing/doc/kk/llms.txt


# Пользовательские поля маршрута

Чтобы учитывать информацию о маршруте, для которой недостаточно стандартного набора полей, можно создавать пользовательские поля `custom_fields`.

{% note warning %}

Функциональность доступна только пользователям API.

{% endnote %}

Дополнительные поля добавляются и удаляются через обращение в службу поддержки. Также в службе поддержки можно уточнить, какие пользовательские поля уже добавлены. 

При работе с пользовательскими полями учитывайте следующие особенности:

- В маршруте можно использовать только те поля, которые добавлены в настройки компании.
- Пользователь самостоятельно следит за форматом и содержимым полей.
- Для одной компании можно добавить не более 10 полей.
- Максимальная длина поля с названием и значением — 255 символов.
- Если удалить какое-либо поле, оно останется в уже созданных маршрутах.
- При [редактировании маршрута](#patch-fields) сохраняются только те поля, которые есть в запросе. Остальные поля удаляются из маршрута.

Пользовательские поля отображаются:

- в разделе **Карта**.
    
    {% cut "Пример" %}
    
    ![](../_images/custom-field-map.png)
    
    {% endcut %}
    
- в карточке курьера.
    
    {% cut "Пример" %}
    
    ![](../_images/custom-field-info.png)
    
    {% endcut %}
    
- в отчете **Качество работы курьера**.
    
    {% cut "Пример" %}
    
    ![](../_images/custom-field-report.png)
    
    {% endcut %}   
    

## Создать маршрут {#post-fields}

Чтобы создать маршрут с пользовательскими полями:

1. Сообщите службе поддержки название полей, которые нужно добавить. Например, `route_type` и `route_priority`.
1. Отправьте POST-запрос к ресурсу [routes](https://yandex.ru/routing/doc/ru/delivery/redoc/index.html#operation/addsARoute). У элемента массива `custom_fields` в поле `key` укажите название, в поле `value` — соответствующее значение. Например, в запросе ниже для `route_type` укажем значение `межгород`, для `route_priority` — `0`.
    

#### Запрос

cURL

```
curl -H "Content-Type: application/json" -H "Authorization: OAuth <ваш-токен>" -X POST -d @<Путь_до_файла_в_кодировке_UTF-8> https://courier.yandex.ru/api/v1/companies/<id-вашей-компании>/routes
```

Файл

```json
{
    "courier_number": "Courier 1",
    "date": "2022-05-12",
    "number": "add-custom-fields",
    "depot_number": "111",
    "route_start": "8:00:00",
    "route_finish": "19:00:00",
    "custom_fields": [
        {
            "key": "route_type",
            "value": "межгород"
        },
        {
            "key": "route_priority",
            "value": "0"
        }
    ]
}

```

#### Результат

```json
{
    "id": <id-маршрута>,
    "company_id": <id-вашей-компании>,
    "courier_id": <id-курьера>,
    "car_id": null,
    "custom_fields": [
        {
            "key": "route_type",
            "value": "межгород"
        },
        {
            "key": "route_priority",
            "value": "0"
        }
    ],
    "depot_id": <id-склада>,
    "number": "add-custom-fields",
    "date": "2022-05-12",
    "imei": null,
    "rented_courier_id": null,
    "courier_violated_route": false,
    "routing_mode": "driving",
    "tracking_start_h": null,
    "route_start": "08:00:00",
    "route_finish": "19:00:00",
    "imei_str": null
}
```

## Отредактировать маршрут {#patch-fields}

Чтобы изменить значения пользовательских полей, отправьте PATCH-запрос к ресурсу [routes](https://yandex.ru/routing/doc/ru/delivery/redoc/index.html#operation/editsRoute). Например, можно оставить в маршруте только поле `route_priority` со значением `1`.

#### Запрос

cURL

```
curl -H "Content-Type: application/json" -H "Authorization: OAuth <ваш-токен>" -X PATCH -d @<Путь_до_файла_в_кодировке_UTF-8> https://courier.yandex.ru/api/v1/companies/<id-вашей-компании>/routes/<id-маршрута>
```

Файл

```json
{
    "courier_number": "Courier 1",
    "date": "2022-05-12",
    "number": "add-custom-fields",
    "depot_number": "111",
    "route_start": "8:00:00",
    "route_finish": "19:00:00",
    "custom_fields": [
        {
            "key": "route_priority",
            "value": "1"
        }
    ]
}
```

#### Результат

```json
{
    "id": <id-маршрута>,
    "company_id": <id-вашей-компании>,
    "courier_id": <id-курьера>,
    "car_id": null,
    "custom_fields": [
        {
            "key": "route_priority",
            "value": "1"
        }
    ],
    "depot_id": <id-склада>,
    "number": "add-custom-fields",
    "date": "2022-05-12",
    "imei": null,
    "rented_courier_id": null,
    "courier_violated_route": false,
    "routing_mode": "driving",
    "tracking_start_h": null,
    "route_start": "08:00:00",
    "route_finish": "19:00:00",
    "imei_str": null
}
```

## Получить маршрут {#get-fields}

Чтобы получить маршруты со значениями пользовательских полей, отправьте GET-запрос к ресурсу [routes](https://yandex.ru/routing/doc/ru/delivery/redoc/index.html#operation/getsMultipleRoutes).

#### Запрос

cURL

```
curl -H "Content-Type: application/json" -H "Authorization: OAuth <ваш-токен>" -X GET -d @<Путь_до_файла_в_кодировке_UTF-8> https://courier.yandex.ru/api/v1/companies/<id-вашей-компании>/routes
```

#### Результат

```json
[
    {
        "id": <id-маршрута>,
        "company_id": <id-вашей-компании>,
        "courier_id": <id-курьера>,
        "car_id": null,
        "custom_fields": [
            {
                "key": "route_priority",
                "value": "1"
            }
        ],
        "depot_id": <id-склада>,
        "number": "add-custom-fields",
        "date": "2022-05-12",
        "imei": null,
        "rented_courier_id": null,
        "courier_violated_route": false,
        "routing_mode": "driving",
        "tracking_start_h": null,
        "route_start": "08:00:00",
        "route_finish": "19:00:00",
        "imei_str": null
    }
]
```

<!-- source: kk/delivery/_includes/feedback.md -->


[//]: # (Вариант без html\: \[Написать в службу поддержки\]\(../../../feedback.md\))

<!-- source: kk/_includes/neuroexpert.md -->
<div style="display: none;"> </div>
<!-- endsource: kk/_includes/neuroexpert.md -->
<!-- endsource: kk/delivery/_includes/feedback.md -->