Редактирует несколько заказов

Добавляет информацию о новых заказах в базу данных или обновляет информацию о существующих при совпадении их номеров.

Request

POST

https://courier.yandex.ru/api/v1/companies/{company_id}/orders-batch

Path parameters

Name

Description

company_id*

Type: integer<int64>

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

Body

application/json

[
    {
        "address": "string",
        "amount": 0,
        "comments": "string",
        "customer_name": "string",
        "description": "string",
        "lat": 0,
        "lon": 0,
        "number": "string",
        "customer_number": "string",
        "payment_type": "cash",
        "payment_status": "paid",
        "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,
        "sms_delivery_confirmation": null,
        "time_interval": "string",
        "route_number": "string",
        "shared_with_company_numbers": [
            "string"
        ],
        "type": "string",
        "show_yandex_pay_button": false,
        "refined_lat": 0,
        "refined_lon": 0,
        "notifications": [
            {
                "type": "before_arrival"
            }
        ]
    }
]

OrdersBatch[]

OrdersBatch

Заказ на выполнение пакетных операций. Для существующего заказа необходимо указать 'number'. Для нового заказа необходимо указать 'number', 'time_interval', 'address', 'lat', 'lon', а также 'route_number' или 'route_id'.

Name	Description
address	Type: string Адрес доставки в текстовом формате.
amount	Type: number<float> Стоимость заказа в рублях. Min value: `0`
comments	Type: string Комментарии к заказу.
customer_name	Type: string Имя заказчика. Max length: `1023`
customer_number	Type: string Номер клиента в базе данных компании, выполняющей доставку. Max length: `128`
description	Type: string Описание заказа. Max length: `1023`
eta_type	Type: string Тип ETA. Влияет на время оповещения и автоматического определения доставки. `arrival_time`: отсчёт ведётся от момента прибытия курьера на точку; `delivery_time`: отсчёт начинается не раньше начала окна доставки. Default: `null`
lat	Type: number<float> Широта точки доставки.
lon	Type: number<float> Долгота точки доставки.
mark_delivered_radius	Type: number<float> Радиус в метрах. Если `null`, используется depot.mark_delivered_radius или company.mark_delivered_radius. Заказ помечается как доставленный автоматически, если значение mark_delivered_enabled равно `true`, а транспортное средство провело не менее mark_delivered_service_time_coefficient * (order.service_duration_s + order.shared_service_duration_s) секунд в пределах mark_delivered_radius метров от местоположения заказа. Default: `null` Min value: `0` Max value: `10000`
notifications	Type: RouteOrderNotification[] Список настроек push-уведомлений.
number	Type: string Номер заказа. Используется для синхронизации с учетной системой компании, выполняющей доставку. Max length: `80`
payment_status	Type: string Состояние оплаты. Возможные значения: paid — Заказ оплачен. unpaid — Заказ не оплачен. Enum: `paid`, `unpaid`, `null`
payment_type	Type: string Способ оплаты. Возможные значения: cash — Оплата наличными курьеру. card — Оплата банковской картой курьеру. prepaid — Предоплата (заказ был оплачен ранее). yandex_pay — Оплата заказа через Яндекс Пэй. Снаружи этот способ оплаты задать нельзя. Enum: `cash`, `card`, `prepaid`, `yandex_pay`, `null`
phone	Type: string Телефон получателя.
refined_lat	Type: number<float> Широта реальной (уточнённой курьером) точки доставки.
refined_lon	Type: number<float> Долгота реальной (уточнённой курьером) точки доставки.
route_id	Type: integer<int64> ID маршрута, используемый в запросах к API Мониторинга.
route_number	Type: string Номер маршрута. Используется для синхронизации с системой компании, выполняющей доставку. Для создания нового заказа в запросе необходимо указать `route_id` или `route_number`. Если указаны и `route_id`, и `route_number`, используется `route_number`.
service_duration_s	Type: integer Ожидаемое время, потраченное курьером на отгрузку товара получателю, в том числе чтобы подняться на этаж и получить оплату. Значение по умолчанию: 600 секунд.
shared_service_duration_s	Type: integer Продолжительность обслуживания в точке доставки, которая может быть разделена с другими заказами в том же месте. Общая продолжительность обслуживания может включать такие операции, как парковка, доставка документов и другие. Значение по умолчанию: 0 секунд.
shared_with_company_ids	Type: number[] ID компаний, которые могут получить доступ к информации о заказе. Предоставляется следующая информация: Полная информация о заказе. Общее описание маршрута, частью которого является заказ. Общее описание склада, используемого в заказе. Общая информация о компании, выполняющей доставку (название и логотип). Если определены оба поля `shared_with_company_numbers` и `shared_with_company_ids`, используется `shared_with_company_numbers`.
shared_with_company_numbers	Type: string[] Номера компаний, которые могут получить доступ к информации о заказе. Предоставляется следующая информация: Полная информация о заказе. Общее описание маршрута, частью которого является заказ. Общее описание склада, используемого в заказе. Общая информация о компании, выполняющей доставку (название и логотип). Если определены оба поля `shared_with_company_numbers` и `shared_with_company_ids`, используется `shared_with_company_numbers`.
show_yandex_pay_button	Type: boolean Показывать кнопку Яндекс Пэй.
sms_delivery_confirmation	Type: boolean Нужно ли курьеру подтверждать доставку кодом из СМС Default: `null`
status	Type: string Текущий статус заказа. Возможные значения: new - заказ был создан. confirmed - установлен срок доставки заказа (подтверждено получателем). finished - заказ доставлен. partially_finished - заказ был доставлен только частично. Для установки статуса заказа в `partially_finished` флаг `company.partially_finished_status_enabled` должен иметь значение `true`. cancelled - заказ был отменен. postponed - заказ отложен или курьер не смог связаться с клиентом.
time_interval	Type: string Желаемое окно доставки заказа. Поддерживаются следующие форматы: "T - T" или "T-T", где T - это время в формате ЧЧ, ЧЧ:ММ, или ЧЧ:ММ:СС. ISO 8601, например, 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00.
type	Type: string Тип заказа. Возможные значения `delivery`, `pickup`, `drop_off`.
volume	Type: number<float> Объем заказа.
weight	Type: number<float> Вес заказа.

RouteOrderNotification

Name

Description

type

Type: string

Тип уведомления.

Enum: before_arrival

Responses

200 OK

Информация о заказах зарегистрирована в базе данных или обновлена.

401 Unauthorized

Ошибка авторизации. Убедитесь, что заголовок запроса содержит правильный OAuth-токен.

403 Forbidden

Ошибка доступа к объекту. У пользователя недостаточно прав для доступа к объекту.

404 Not Found

Ошибка поиска объекта. Объект не найден.

422 Unprocessable Entity

Неверный ввод. Операция не может быть выполнена.

504 Gateway Timeout

Ошибка при работе с API. Повторите запрос.

Was the article helpful?

Добавляет заказ

Удаляет заказ