Добавляет планы маршрутов.

  1. HTTP-запрос
  2. Path-параметры
  3. Тело запроса
    1. Представление
    2. Поля
  4. Ответы
    1. Код 200
    2. Код 401
    3. Код 403
    4. Код 422

Добавляет информацию о планах маршрутов.

HTTP-запрос

POST https://courier.yandex.ru/api/v1/companies/{company_id}/route-plans

Path-параметры

company_id *

integer

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

company_id *

integer

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

Тело запроса

[
  {
    "nodes": [
      {
        "arrival_time_s": number,
        "departure_time_s": number,
        "transit_distance_m": number,
        "type": string,
        "used_time_window": string,
        "value": {
          "address": string,
          "customer_name": string,
          "multi_order": boolean,
          "number": string,
          "point": {
            "lat": number,
            "lon": number
          },
          "service_duration_s": integer,
          "shared_service_duration_s": integer,
          "shipment_size": {
            "amount": number,
            "volume_cbm": number,
            "weight_kg": number
          }
        }
      }
    ],
    "number": string
  }
]
Скопировано

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

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

Поля

nodes[] *

array

Запланированные узлы маршрута.

nodes[].arrival_time_s *

number

Расчетное время прибытия в секундах с полуночи.

Минимальное значение: 0.

nodes[].departure_time_s

number

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

Минимальное значение: 0.

nodes[].transit_distance_m *

number

Расстояние до пункта назначения, в метрах.'

Минимальное значение: 0.

nodes[].type *

string

Тип узла. Всегда равен depot.

nodes[].used_time_window *

string

Ожидаемый интервал времени обслуживания в формате "T - T" или "T-T", где T – время в формате HH, HH:MM или HH:MM:SS.

nodes[].value *

object

nodes[].value.address

string

Адрес узла в текстовом формате.

nodes[].value.number *

string

Номер узла.

nodes[].value.point *

object

nodes[].value.point.lat *

number

Широта точки.

nodes[].value.point.lon *

number

Долгота точки.

nodes[].value.service_duration_s

integer

Время, затраченное в данном узле.

Минимальное значение: 0.

nodes[].arrival_time_s *

number

Расчетное время прибытия в секундах с полуночи.

Минимальное значение: 0.

nodes[].departure_time_s

number

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

Минимальное значение: 0.

nodes[].transit_distance_m *

number

Расстояние до пункта назначения, в метрах.'

Минимальное значение: 0.

nodes[].type *

string

Тип узла. Всегда равен garage.

nodes[].used_time_window

string

Ожидаемый интервал времени обслуживания в формате "T - T" или "T-T", где T – время в формате HH, HH:MM или HH:MM:SS.

nodes[].value *

object

nodes[].value.address

string

Адрес узла в текстовом формате.

nodes[].value.number *

string

Номер узла.

nodes[].value.point *

object

nodes[].value.point.lat *

number

Широта точки.

nodes[].value.point.lon *

number

Долгота точки.

nodes[].value.service_duration_s

integer

Время, затраченное в данном узле.

Минимальное значение: 0.

nodes[].arrival_time_s *

number

Расчетное время прибытия в секундах с полуночи.

Минимальное значение: 0.

nodes[].departure_time_s *

number

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

Минимальное значение: 0.

nodes[].transit_distance_m *

number

Расстояние до пункта назначения, в метрах.'

Минимальное значение: 0.

nodes[].type *

string

Тип узла. Всегда равен order.

nodes[].used_time_window *

string

Ожидаемый интервал времени обслуживания в формате "T - T" или "T-T", где T – время в формате HH, HH:MM или HH:MM:SS.

nodes[].value *

object

nodes[].value.address

string

Адрес узла в текстовом формате.

nodes[].value.customer_name

string

Имя заказчика в заказе.

nodes[].value.multi_order

boolean

Заказ является доставляется в один и тот же пункт назначения вместе с другими заказами.

nodes[].value.number *

string

Номер узла.

nodes[].value.point *

object

nodes[].value.point.lat *

number

Широта точки.

nodes[].value.point.lon *

number

Долгота точки.

nodes[].value.service_duration_s *

integer

Время, затраченное в данном узле.

Минимальное значение: 0.

nodes[].value.shared_service_duration_s

integer

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

Минимальное значение: 0.

nodes[].value.shipment_size

object

nodes[].value.shipment_size.amount

number

Размер заказа в пользовательских единицах измерения.

Минимальное значение: 0.

nodes[].value.shipment_size.volume_cbm

number

Объем заказа.

Минимальное значение: 0.

nodes[].value.shipment_size.weight_kg

number

Вес заказа.

Минимальное значение: 0.

number *

string

Номер маршрута.

nodes[] *

array

Запланированные узлы маршрута.

nodes[].arrival_time_s *

number

Расчетное время прибытия в секундах с полуночи.

Минимальное значение: 0.

nodes[].departure_time_s

number

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

Минимальное значение: 0.

nodes[].transit_distance_m *

number

Расстояние до пункта назначения, в метрах.'

Минимальное значение: 0.

nodes[].type *

string

Тип узла. Всегда равен depot.

nodes[].used_time_window *

string

Ожидаемый интервал времени обслуживания в формате "T - T" или "T-T", где T – время в формате HH, HH:MM или HH:MM:SS.

nodes[].value *

object

nodes[].value.address

string

Адрес узла в текстовом формате.

nodes[].value.number *

string

Номер узла.

nodes[].value.point *

object

nodes[].value.point.lat *

number

Широта точки.

nodes[].value.point.lon *

number

Долгота точки.

nodes[].value.service_duration_s

integer

Время, затраченное в данном узле.

Минимальное значение: 0.

nodes[].arrival_time_s *

number

Расчетное время прибытия в секундах с полуночи.

Минимальное значение: 0.

nodes[].departure_time_s

number

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

Минимальное значение: 0.

nodes[].transit_distance_m *

number

Расстояние до пункта назначения, в метрах.'

Минимальное значение: 0.

nodes[].type *

string

Тип узла. Всегда равен garage.

nodes[].used_time_window

string

Ожидаемый интервал времени обслуживания в формате "T - T" или "T-T", где T – время в формате HH, HH:MM или HH:MM:SS.

nodes[].value *

object

nodes[].value.address

string

Адрес узла в текстовом формате.

nodes[].value.number *

string

Номер узла.

nodes[].value.point *

object

nodes[].value.point.lat *

number

Широта точки.

nodes[].value.point.lon *

number

Долгота точки.

nodes[].value.service_duration_s

integer

Время, затраченное в данном узле.

Минимальное значение: 0.

nodes[].arrival_time_s *

number

Расчетное время прибытия в секундах с полуночи.

Минимальное значение: 0.

nodes[].departure_time_s *

number

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

Минимальное значение: 0.

nodes[].transit_distance_m *

number

Расстояние до пункта назначения, в метрах.'

Минимальное значение: 0.

nodes[].type *

string

Тип узла. Всегда равен order.

nodes[].used_time_window *

string

Ожидаемый интервал времени обслуживания в формате "T - T" или "T-T", где T – время в формате HH, HH:MM или HH:MM:SS.

nodes[].value *

object

nodes[].value.address

string

Адрес узла в текстовом формате.

nodes[].value.customer_name

string

Имя заказчика в заказе.

nodes[].value.multi_order

boolean

Заказ является доставляется в один и тот же пункт назначения вместе с другими заказами.

nodes[].value.number *

string

Номер узла.

nodes[].value.point *

object

nodes[].value.point.lat *

number

Широта точки.

nodes[].value.point.lon *

number

Долгота точки.

nodes[].value.service_duration_s *

integer

Время, затраченное в данном узле.

Минимальное значение: 0.

nodes[].value.shared_service_duration_s

integer

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

Минимальное значение: 0.

nodes[].value.shipment_size

object

nodes[].value.shipment_size.amount

number

Размер заказа в пользовательских единицах измерения.

Минимальное значение: 0.

nodes[].value.shipment_size.volume_cbm

number

Объем заказа.

Минимальное значение: 0.

nodes[].value.shipment_size.weight_kg

number

Вес заказа.

Минимальное значение: 0.

number *

string

Номер маршрута.

Ответы

Код 200

Планы маршрутов добавлены.

Код 401

Ошибка авторизации. Отправьте правильный OAuth-токен в заголовке авторизации.

Код 403

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

Код 422

Неправильный ввод.