Параметры заказов

Идентификатор заказа

Обязательным атрибутом заказа является уникальный идентификатор, который задается в поле client_order_id. Он не должен повторяться в течение дня и на протяжении всего периода планирования. Для соблюдения уникальности добавляйте к идентификатору текущую дату. Например, Order1 2025-01-01.

Местоположение заказа

Корректность адреса или координат имеет большое значение для получения хороших результатов прогнозирования маршрута.

Для передачи адреса используется блок address. Уделите внимание тому, как в вашей системе появляются и хранятся адреса:

  • Если клиенты указывают адреса в форме на сайте, рекомендуем подключить проверку ввода адресов (например, проверку Яндекса).

  • Если адреса вводят сотрудники компании, рекомендуем упорядочить процесс ввода. Часто адрес набирают сплошной строкой, в том же поле сохраняют комментарий и информацию по окну доставки.

Для определения координат заказа используются поля coordinates.latitude и coordinates.longitude. Важно убедиться, что координаты не перепутаны местами и нет координат, которые по значениям сильно отличаются от остальных.

Политика доставки

Параметр

Описание

Тип

type

Тип политики доставки

Строка

deadline

Точное время

Дата и время в формате ISO 8601 и RFC 3339

time_interval

Временной интервал

Дата и время в формате ISO 8601 и RFC 3339

Содержимое заказа

Список товаров в заказе передается в блоке content.verbose_item_list. Для корректного распределения нагрузки на курьеров указывайте в блоке content.dimensions размеры заказа:

Параметр

Описание

Тип

weight_gross_g

Вес заказа (в граммах)

Целое число

units_count

Количество единиц товара

Целое число

Совместимость заказа и курьеров

При определении заказа в запросе к Маршрутизации возможно назначить список требований к курьеру, который должен выполнить данный заказ.

Правила совместимости курьеров и заказов (теги заказа) задаются в параметре order_list.required_tag_list. Они должны совпадать со свойствами курьеров.

Приоритет заказа

Приоритет заказа задается в поле order_priority. Возможны следующие значения:

  • standard;
  • express.

Продолжительность этапов заказа

Параметр

Описание

Тип

order_preparing_duration_s

Время подготовки заказа (в секундах)

Целое число

source_order_exchange_service_duration_s

Время передачи заказа курьеру на стартовой точке (в секундах)

Целое число

destination_order_exchange_service_duration_s

Время вручения заказа на точке назначения (в секундах)

Целое число

Информация о платеже

В поле payment_method передайте информацию о платеже — метод оплаты заказа без персональных или платежных данных.

Информация о получателе заказа

В поле recipient_id передайте информацию о получателе — идентификатор без персональных данных.