Описание справочников и настроек

Поле

Описание

ID Компании в Яндекс Маршрутизация

Идентификатор компании в Яндекс Маршрутизации (число). В интерфейсе содержится в адресной строке браузера: https://yandex.ru/courier/companies/<ID Компании>.

Ключ API для Яндекс Маршрутизация

Ключ для доступа к сервису планирования. В интерфейсе сервиса его можно увидеть в разделе Настройки → Компания → API Key.

Поле

Описание

Адрес сервиса Яндекс Геокодирование

Предопределенное значение: geocode-maps.yandex.ru, менять не требуется.

Заполнять координаты случайными значениями

Предопределенное значение: Да. При нем для адресов заказов будут формироваться случайные координаты (в зависимости от координат склада). Используется, когда нужно протестировать модуль без Геокодера. Если вы приобрели Геокодер и ввели ключ в поле КлючAPI для Яндекс Геокодирование, укажите значение Нет.

КлючAPI для Яндекс Геокодирование

Ключ для сервиса геокодирования. Отличается от КлючAPI для Яндекс Маршрутизация.

Область поиска, по долготе

Предопределенное значение: 3. Задается в координатах. Поиск координат по долготе осуществляется в зависимости от долготы склада ± Область поиска, по долготе / 2 (используется при расчете параметра Геокодера bbox).

Область поиска, по широте

Предопределенное значение: 3. Задается в координатах. Поиск координат по широте осуществляется в зависимости от широты склада ± Область поиска, по широте / 2 (используется при расчете параметра Геокодера bbox).

Поле

Описание

Радиус на точке доставки по умолчанию, м

Предопределенное значение: 500. Соответствует полю mark_delivered_radius при добавлении/обновлении заказов в API Мониторинга.

Статус заказа по умолчанию

Предопределенное значение: new. Также допустимо confirmed (при нем в мобильном приложении Яндекс Курьер предварительно звонить клиенту необязательно: можно сразу выполнять маршрут). Соответствует полю status при добавлении/обновлении заказов в API Мониторинга.

Токен для Яндекс Мониторинг

Токен для загрузки данных в сервис мониторинга (см. раздел Получение OAuth-токена). Токен нужно получать через учетную запись, которая имеет доступ уровня Администратор к вашему ID компании в сервисе Яндекс Маршрутизация.

Значение отличается от КлючAPI для Яндекс Маршрутизация и КлючAPI для Яндекс Геокодирование.

Поле

Описание

Временное окно заказа

Предопределенное значение: 0.07:00:00 – 0.23:00:00. Соответствует полю time_window для location при отправке запроса на построение маршрутов. В модуле используется общее временное окно для всех заказов.

Временное окно нужно указывать в относительном формате с учетом сдвига от даты планирования.Например, 0.20:00:00 – 1.06:00:00 — это промежуток с 20 часов текущего дня до 6 утра следующего дня (отсчет ведется от даты планирования).

Жесткое временное окно заказа

Предопределенное значение: Да. Соответствует полю hard_window для location при отправке запроса на построение маршрутов. Подробнее см. Временное окно заказа.

Настройки штрафов для заказов

Предопределенное значение: ссылка на элемент справочника Настройки штрафов для алгоритма. Соответствует полям location при отправке запроса на построение маршрутов:

• penalty.drop
• penalty.early.fixed
• penalty.early.minute
• penalty.late.fixed
• penalty.late.minute
• penalty.out_of_time.fixed
• penalty.out_of_time.minute

Cм. описание штрафов за нарушение временных окон заказов и недоставку.

Сервисное время на адрес, c

Предопределенное значение: 900. Соответствует полю shared_service_duration_s для location при отправке запроса на построение маршрутов. Подробнее см. Сервисное время при доставке заказов.

Сервисное время на заказ, с

Предопределенное значение: 120. Соответствует полю service_duration_s для location при отправке запроса на построение маршрутов. Подробнее см. Сервисное время при доставке заказов.

Тип заказа

Предопределенное значение: delivery. Также допускается значение pickup (для случаев, когда выполняется сбор заказов для доставки на склад). Другие типы заказов в модуле не поддерживаются. Подробнее см. Тип заказа.

Соответствует полю type для location при отправке запроса на построение маршрутов.

Поле

Описание

Адрес запроса результата маршрутизации

Предопределенное значение: /vrs/api/v1/result/mvrp/, менять не требуется.

Адрес отправки запроса на маршрутизацию

Предопределенное значение: /vrs/api/v1/add/mvrp?apikey=, менять не требуется.

Адрес просмотра результатов планирования

Предопределенное значение: https://courier.yandex.ru/mvrp-map#, менять не требуется.

Адрес сервиса Яндекс Маршрутизация

Предопределенное значение: courier.yandex.ru, менять не требуется.

Поле

Описание

merge_multiorders

Предопределенное значение: Да. Соответствует полю merge_multiorders для options при отправке запроса на построение маршрутов. Подробнее см. Мультизаказы.

penalize_late_service

Предопределенное значение: Нет. Соответствует полю penalize_late_service для options при отправке запроса на построение маршрутов. Подробнее см. в разделе Штраф за обслуживание вне временного окна.

proximity_factor

Предопределенное значение отсутствует. Соответствует полю proximity_factor для options при отправке запроса на построение маршрутов. Подробнее см. в разделе Кучные маршруты.

Использовать группы балансировки

Предопределенное значение: Да. Определяет, используются ли в решении группы балансировки (в модуле — справочник Группы балансировки). При включенной опции в запрос на маршрутизацию для options вставляется блок balanced_groups. Подробнее см. в разделе Опция равномерной загрузки.

Вид штрафа

Комментарий

Применимость для склада

Применимость для ТС

Применимость для заказа

За факт нарушения временного окна, За факт раннего приезда, За факт опоздания

Предопределенное значение: 1000. Подробнее см. в разделах о штрафах для заказов, транспортных средств, склада. Соответствует полям запроса penalty.out_of_time.fixed, penalty.early.fixed, penalty.late.fixed.

Да

Да

Да

За минуту нарушения временного окна, За минуту раннего приезда, За минуту опоздания

Предопределенное значение: 17. Подробнее см. в разделах о штрафах для заказов, транспортных средств, склада. Соответствует полям запроса penalty.out_of_time.minute, penalty.early.minute, penalty.late.minute.

Да

Да

Да

Штраф за недоставку

Предопределенное значение: 1 000 000. Подробнее см. Штрафы за невыполнение заказа. Соответствует penalty.drop в запросе.

Нет

Нет

Да

За факт превышения максимального количества остановок

Предопределенное значение: 100. Подробнее см. Ограничение количества остановок в смене. Соответствует penalty.stop_excess.fixed в запросе.

Нет

Да

Нет

За каждую остановку сверх максимального количества

Предопределенное значение: 100. Подробнее см. Ограничение количества остановок в смене. Соответствует penalty.stop_excess.per_stop в запросе.

Нет

Да

Нет

За факт не достижения минимального количества остановок

Предопределенное значение: 100. Подробнее см. Ограничение количества остановок в смене. Соответствует penalty.stop_lack.fixed в запросе.

Нет

Да

Нет

За каждую остановку меньше минимального количества

Предопределенное значение: 100. Подробнее см. Ограничение количества остановок в смене. Соответствует penalty.stop_lack.per_stop в запросе.

Нет

Да

Нет

За факт превышения максимального пробега

Предопределенное значение: 100. Подробнее см. Максимальный пробег за смену. Соответствует penalty.max_mileage.fixed в запросе.

Нет

Да

Нет

За каждый километр превышения максимального пробега

Предопределенное значение: 100. Подробнее см. Максимальный пробег за смену. Соответствует penalty.max_mileage.km в запросе.

Нет

Да

Нет

Поле

Описание

Код

Идентификатор склада. Соответствует полю id для depot в запросе на маршрутизацию.

Работает

Укажите Да, чтобы использовать этот склад в модуле.

Наименование

Наименование склада. Соответствует полю ref для depot.

Адрес

Необязательное информационное поле.

Склад 1С

Устанавливает соответствие склада в модуле значению из стандартного справочника складов в 1С. Если установлено, в рабочем месте логиста фильтруются только заказы с указанного склада.

Широта, Долгота

Координаты склада. Соответствует полям point.lon и point.lat для depot.

Временное окно

Временное окно работы склада. Соответствует полю time_window для depot. Заполнять нужно в относительном формате с учетом сдвига от даты планирования. Например, 0.20:00:00 - 1.06:00:00 — это промежуток с 20 часов текущего дня до 6 утра следующего дня (отсчет ведется от даты планирования).

Жесткое временное окно

Жесткость временного окна склада. Соответствует полю hard_window для depot.

Сервисное время в начале рейса, Сервисное время в конце рейса

Время, которое добавляется в начале/конце каждого рейса (в случае возврата на склад). Подробнее см. Сервисное время на складе. Соответствуют полям service_duration_s и finish_service_duration_s для depot.

Гибкое время старта

Определяет, должно ли время старта рассчитываться алгоритмом или оно совпадает с началом временного окна смены или склада. Соответствует полю flexible_start_time для depot.

Штрафы

Ссылка на элемент справочника Настройки штрафов для алгоритма. Соответствует полям depot при отправке запроса на построение маршрутов:

• penalty.early.fixed
• penalty.early.minute
• penalty.late.fixed
• penalty.late.minute
• penalty.out_of_time.fixed
• penalty.out_of_time.minute

Поле

Описание

Наименование

Наименование транспортного средства. Соответствует полю ref для vehicle.

Работает

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

Номер машины (логин курьера)

Идентификатор транспортного средства. Соответствует полю id для vehicle.В Мониторинге поле используется как логин в мобильном приложении.

Номер телефона

Необязательное информационное поле.

Способ перемещения

Возможные значения: Автомобиль, Грузовой автомобиль, Пешком, Общественный транспорт. Соответствует полю routing_mode для vehicle. Подробнее см. Режим маршрутизации.

Поле

Описание

Количество мест

Вместимость ТС по количеству грузовых мест. Соответствует полю units для vehicle.capacity.

Грузоподъемность, кг

Грузоподъемность ТС. Соответствует полю weight_kg для vehicle.capacity.

Максимальная длина груза, м, Максимальная ширина груза, м, Максимальная высота груза, м

Габариты кузова ТС. Вместимость ТС по объему будет вычисляться как произведение данных полей. Соответствует полям depth_m, width_m, height_m для vehicle.capacity.volume.

Стоимость за км, Стоимость за час, Фиксированная стоимость, Стоимость за рейс, Стоимость за заказ

Стоимость использования ТС (необходима для алгоритма оптимизации). Соответствует полям km, hour, fixed, run, location для vehicle.cost.

Максимальное количество рейсов

Максимальное количество рейсов ТС. Соответствует полю max_runs для vehicle.

Старт не на складе

Если курьер стартует не со склада, укажите Да. Подробнее см. Старт автомобиля не со склада.

Заехать на склад после точки старта

Если курьеру после старта не на складе нужно заехать на склад, укажите Да. Подробнее см. Посещение склада перед началом рабочего дня.

Временное окно точки старта

Если Старт не на складе = Да, укажите в этом поле временное окно, когда можно стартовать (для точки старта в запросе на маршрутизацию передается отдельный location c типом garage).

Широта точки старта, Долгота точки старта

Если Старт не на складе = Да, в этих полях укажите координаты точки старта (для точки старта в запросе на маршрутизацию передается отдельный location c типом garage).

Завершение не на складе

Если курьер завершает маршрут не на складе, включите эту опцию. Подробнее см. Возврат на произвольную точку в конце маршрута.

Возврат на склад

Если курьеру нужно вернуться на склад в конце маршрута, включите эту опцию. Подробнее см. Возврат на склад в конце рабочего дня. Если одновременно включены Завершение не на складе и Возврат на склад, то курьер вернется сначала на склад, а затем — в точку завершения маршрута.

Временное окно точки завершения

Если Завершение не на складе = Да, укажите временное окно, когда можно вернуться в точку завершения (для точки завершения в запросе на маршрутизацию передается отдельный location c типом garage).

Широта точки завершения, Долгота точки завершения

Если Завершение не на складе = Да, укажите координаты точки завершения (для точки завершения в запросе на маршрутизацию передается отдельный location c типом garage).

Поле

Описание

Тег

Ссылка на элемент справочника Теги (совместимость заказов и ТС). Может быть задано несколько элементов. Подробнее см. Теги автомобиля. Соответствует полю tags для vehicle.

Поле

Описание

Номер

Соответствует полю id для элемента vehicle.shifts. Для одного ТС может быть задано несколько смен.

Штрафы

Ссылка на элемент справочника Настройки штрафов для алгоритма. Соответствует полям vehicle.shifts при отправке запроса на построение маршрутов:

• penalty.early.fixed
• penalty.early.minute
• penalty.late.fixed
• penalty.late.minute
• penalty.out_of_time.fixed
• penalty.out_of_time.minute
• penalty.max_mileage.fixed
• penalty.max_mileage.km
• penalty.stop_excess.fixed
• penalty.stop_excess.per_stop
• penalty.stop_lack.fixed
• penalty.stop_lack.per_stop

Группа балансировки

Ссылка на элемент справочника Группа балансировки. Заполните, если для ТС нужна равномерность маршрутов. Соответствует полю balanced_group_id для элемента vehicle.shifts.

Временное окно

Соответствует полю time_windows для элемента vehicle.shifts. Подробнее см. Смены работы автомобиля или курьера.

Жесткое временное окно

Соответствует полю hard_windows для элемента vehicle.shifts. Подробнее см. Смены работы автомобиля или курьера.

Минимальное количество стопов

Соответствует полю minimal_stops для элемента vehicle.shifts. Подробнее см. Ограничение количества остановок в смене.

Максимальное количество стопов

Соответствует полю maximal_stops для элемента vehicle.shifts. Подробнее см. Ограничение количества остановок в смене.

Максимальный пробег, км

Соответствует полю max_mileage_km для элемента vehicle.shifts. Подробнее см. Максимальный пробег за смену.

Максимальная продолжительность смены, с

Соответствует полю max_duration_s для элемента vehicle.shifts. Подробнее см. Максимальная продолжительность смены.

Поле

Описание

ID группы балансировки

Идентификатор группы. Указывается на сменах тех ТС, которые нужно балансировать по времени/количеству остановок.

Штраф за отклонение от среднего времени маршрута

Предопределенное значение: 200. Если не нужно балансировать по продолжительности маршрута, укажите 0.

Штраф за отклонение от среднего количества остановок

Предопределенное значение: 100. Если не нужно балансировать по количеству остановок, укажите 0.

Поле

Описание

Наименование

Cправочник в дальнейшем можно использовать для транспортного средства. На заказах теги нужно заполнять вручную в Рабочем месте логиста в поле Необходимые свойства машины (либо доработать автоматизированное заполнение тегов для заказов). Подробнее см. Теги автомобиля.

Поле

Описание

Период

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

Id

Уникальный идентификатор задачи планирования. Каждая задача представлена ссылкой, при нажатии на которую открывается карта для просмотра результатов решения задачи.

Сообщение

Ответ от сервиса планирования маршрутов. Содержит текущий статус решения задачи или текст ответа от сервиса (если возникли ошибки). Сообщения:

• Task queued — для статуса Отправлен;
• Task started and available for polling или Task is running and available for polling — для статуса Запланирован;
• Task successfully completed — для статуса Завершен.

Статус запроса

Возможные значения: Отправлен, Запланирован, Завершен, Ошибка.