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

Ресурсы API

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

HTTP-запрос

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

Path-параметры

company_id *

integer

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

* Обязательный параметр

Тело запроса

[
  {
    "address": string,
    "amount": number,
    "comments": string,
    "customer_name": string,
    "customer_number": string,
    "eta_type": string,
    "lat": number,
    "lon": number,
    "mark_delivered_radius": number,
    "notifications": [
      {
        "type": string
      }
    ],
    "number": string,
    "payment_status": string,
    "payment_type": string,
    "phone": string,
    "refined_lat": number,
    "refined_lon": number,
    "route_id": integer,
    "route_number": string,
    "service_duration_s": integer,
    "shared_service_duration_s": integer,
    "shared_with_company_ids": [
      number
    ],
    "shared_with_company_numbers": [
      string
    ],
    "show_yandex_pay_button": boolean,
    "status": string,
    "time_interval": string,
    "type": string,
    "volume": number,
    "weight": number,
    "x-description-en": string
  }
]
Скопировано

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

Свернуть всё

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

Поля

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