Задает узлы маршрута и их последовательность
Метод устанавливает последовательность узлов заданного маршрута.
- Заказы, склады и гаражи, которых нет в маршруте, но есть в запросе, создаются и добавляются в маршрут. При этом для гаражей и заказов обязательными полями являются
number
,address
,lat
,lon
. Для заказов дополнительно необходимо указывать полеtime_interval
. - Заказы, склады и гаражи, которые есть в маршруте, но отсутствуют в запросе, удаляются. Удаление уже посещённых узлов маршрута запрещено.
- Заказы и гаражи, которые имеются и в маршруте, и в запросе, при наличии дополнительных полей, кроме
number
, обновляются в соответствии с полученными значениями. Гаражи могут находиться только в начале и конце маршрута. В начале маршрута может быть не больше одного гаража. Если в начале маршрута присутствуют и склад, и гараж, то гараж может быть только перед первым складом. В конце маршрута может быть не больше одного гаража. Если в конце маршрута присутствуют и склад, и гараж, то гараж может быть только после последнего склада.
Request
POST
https://courier.yandex.ru/api/v1/companies/{company_id}/routes/{route_id}/nodes
Path parameters
Name |
Description |
company_id* |
Type: integer<int64> ID компании, используемый в запросах к API Мониторинга. |
route_id* |
Type: integer<int64> ID маршрута, используемый в запросах к API Мониторинга. |
Query parameters
Name |
Description |
mode |
Type: string Определяет режим импорта узлов. Возможные значения: - Default: Enum: |
Body
application/json
[
{
"type": "string",
"value": {
"id": "string",
"type": "pickup",
"address": "string",
"amount": 0,
"comments": "string",
"customer_name": "string",
"customer_number": "string",
"description": "string",
"lat": 0,
"lon": 0,
"number": "string",
"payment_type": "cash",
"phone": "string",
"route_id": 0,
"service_duration_s": 0,
"shared_service_duration_s": 0,
"status": "string",
"volume": 0,
"weight": 0,
"shared_with_company_ids": [
0
],
"mark_delivered_radius": null,
"eta_type": null,
"time_interval": "string",
"notifications": [
{
"type": "before_arrival"
}
],
"related_orders": [
{
"number": "string",
"action": "pickup"
}
]
}
}
]
(RouteNodeOrder or RouteNodeDepot or RouteNodeGarage)[]
RouteNodeOrder
Узел маршрута с типом order
.
Name |
Description |
type* |
Type: string Pattern: |
value* |
Type: RouteNodeOrder_value |
RouteNodeDepot
Узел маршрута с типом "depot".
Name |
Description |
type* |
Type: string Pattern: |
value* |
Type: RouteNodeDepot_value |
RouteNodeGarage
Узел маршрута с типом "garage".
Name |
Description |
type* |
Type: string Pattern: |
value* |
Type: RouteNodeGarage_value |
RouteNodeOrder_value
Name |
Description |
address |
Type: string Адрес доставки в текстовом формате. |
amount |
Type: number<float> Стоимость заказа в рублях. Min value: |
comments |
Type: string Комментарии к заказу. |
customer_name |
Type: string Имя заказчика. Max length: |
customer_number |
Type: string Номер клиента в базе данных компании, выполняющей доставку. Max length: |
description |
Type: string Описание заказа. Max length: |
eta_type |
Type: string Тип ETA. Влияет на время оповещения и автоматического определения доставки. Default: |
id |
Type: string ID заказа, используемый в запросах к API Мониторинга. Pattern: |
lat |
Type: number<float> Широта точки доставки. |
lon |
Type: number<float> Долгота точки доставки. |
mark_delivered_radius |
Type: number<float> Радиус в метрах. Если Default: Min value: Max value: |
notifications |
Type: OrderNotification[] Список настроек push-уведомлений. |
number |
Type: string Номер заказа. Используется для синхронизации с учетной системой компании, выполняющей доставку. Max length: |
payment_type |
Type: string Способ оплаты. Возможные значения:
Enum: |
phone |
Type: string Телефон получателя. |
related_orders |
Type: RelatedOrdersByNumber[] Объект, хранящий информацию о заказе, связаном с точкой, и действии с этими заказом. |
route_id |
Type: integer<int64> ID маршрута, используемый в запросах к API Мониторинга. |
service_duration_s |
Type: integer Ожидаемое время, потраченное курьером на отгрузку товара получателю, в том числе чтобы подняться на этаж и получить оплату. Значение по умолчанию: 600 секунд. |
shared_service_duration_s |
Type: integer Продолжительность обслуживания в точке доставки, которая может быть разделена с другими заказами в том же месте. Общая продолжительность обслуживания может включать такие операции, как парковка, доставка документов и другие. Значение по умолчанию: 0 секунд. |
shared_with_company_ids |
Type: number[] ID компаний, которые могут получить доступ к информации о заказе. Предоставляется следующая информация:
|
status |
Type: string Текущий статус заказа. Возможные значения:
|
time_interval |
Type: string Желаемое окно доставки заказа. Поддерживаются следующие форматы:
|
type |
Type: string Тип обслуживания заказа. Enum: |
volume |
Type: number<float> Объем заказа. |
weight |
Type: number<float> Вес заказа. |
RouteNodeDepot_value
Name |
Description |
number* |
Type: string Номер склада. |
related_orders |
Type: RelatedOrdersByNumber[] Объект, хранящий информацию о заказе, связаном с точкой, и действии с этими заказом. |
status |
Type: string Текущий статус посещения склада. Возможные значения:
|
RouteNodeGarage_value
Name |
Description |
number* |
Type: string Номер гаража. |
address |
Type: string Адрес гаража в текстовом формате. |
lat |
Type: number<float> Широта точки расположения гаража. |
lon |
Type: number<float> Долгота точки расположения гаража. |
OrderNotification
Name |
Description |
type |
Type: string Тип уведомления. Enum: |
RelatedOrdersByNumber
Объект, хранящий информацию о заказе, связаном с точкой, и действии с этими заказом.
Name |
Description |
action |
Type: RelatedOrderAction Действие, выполняемое над заказом: *
Enum: |
number |
Type: string Номер заказа. |
RelatedOrderAction
Действие, выполняемое над заказом: * pickup
— погрузить для доставки в другой пункт назначения (можно погрузить со склада, гаража и pickup-заказа);
delivery
— доставить в этот пункт назначения (может быть складом, гаражом и drop-off заказом).
Type |
Description |
Enum: |
Responses
200 OK
Операция успешно завершена.
400 Bad Request
Недопустимый JSON в теле сообщения.
404 Not Found
Маршрут не найден.
422 Unprocessable Entity
Неверный ввод.
No longer supported, please use an alternative and newer version.