Редактирует несколько заказов
Добавляет информацию о новых заказах в базу данных или обновляет информацию о существующих при совпадении их номеров.
HTTP-запрос
POST https://courier.yandex.ru/api/v1/companies/{company_id}/orders-batch
Path-параметры
company_id * | integer ID компании, используемый в запросах к API Мониторинга. |
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. Влияет на время оповещения и автоматического определения доставки. |
lat | number Широта точки доставки. |
lon | number Долгота точки доставки. |
mark_delivered_radius | number Радиус в метрах. Если Минимальное значение: |
notifications[] | array Список настроек push-уведомлений. |
notifications[]. | string Тип уведомления. Возможные значения
|
number | string Номер заказа. Используется для синхронизации с учетной системой компании, выполняющей доставку. |
payment_status | string Состояние оплаты. Возможные значения:
|
payment_type | string Способ оплаты. Возможные значения:
|
phone | string Телефон получателя. |
refined_lat | number Широта реальной (уточнённой курьером) точки доставки. |
refined_lon | number Долгота реальной (уточнённой курьером) точки доставки. |
route_id | integer ID маршрута, используемый в запросах к API Мониторинга. |
route_number | string Номер маршрута. Используется для синхронизации с системой компании, выполняющей доставку. Для создания нового заказа в запросе необходимо указать |
service_duration_s | integer Ожидаемое время, потраченное курьером на отгрузку товара получателю, в том числе чтобы подняться на этаж и получить оплату. |
shared_service_duration_s | integer Продолжительность обслуживания в точке доставки, которая может быть разделена с другими заказами в том же месте. |
shared_with_company_ids[] | array ID компаний, которые могут получить доступ к информации о заказе. Предоставляется следующая информация:
|
shared_with_company_numbers[] | array Номера компаний, которые могут получить доступ к информации о заказе. Предоставляется следующая информация:
|
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. Влияет на время оповещения и автоматического определения доставки. |
lat | number Широта точки доставки. |
lon | number Долгота точки доставки. |
mark_delivered_radius | number Радиус в метрах. Если Минимальное значение: |
notifications[] | array Список настроек push-уведомлений. |
notifications[]. | string Тип уведомления. Возможные значения
|
number | string Номер заказа. Используется для синхронизации с учетной системой компании, выполняющей доставку. |
payment_status | string Состояние оплаты. Возможные значения:
|
payment_type | string Способ оплаты. Возможные значения:
|
phone | string Телефон получателя. |
refined_lat | number Широта реальной (уточнённой курьером) точки доставки. |
refined_lon | number Долгота реальной (уточнённой курьером) точки доставки. |
route_id | integer ID маршрута, используемый в запросах к API Мониторинга. |
route_number | string Номер маршрута. Используется для синхронизации с системой компании, выполняющей доставку. Для создания нового заказа в запросе необходимо указать |
service_duration_s | integer Ожидаемое время, потраченное курьером на отгрузку товара получателю, в том числе чтобы подняться на этаж и получить оплату. |
shared_service_duration_s | integer Продолжительность обслуживания в точке доставки, которая может быть разделена с другими заказами в том же месте. |
shared_with_company_ids[] | array ID компаний, которые могут получить доступ к информации о заказе. Предоставляется следующая информация:
|
shared_with_company_numbers[] | array Номера компаний, которые могут получить доступ к информации о заказе. Предоставляется следующая информация:
|
show_yandex_pay_button | boolean Показывать кнопку Яндекс Пэй. |
status | string Текущий статус заказа. Возможные значения:
|
time_interval | string Желаемое окно доставки заказа. Поддерживаются следующие форматы:
|
type | string Тип заказа. Возможные значения |
volume | number Объем заказа. |
weight | number Вес заказа. |
x-description-en | string Описание заказа. |
* Обязательный параметр
Ответы
Код 200
Информация о заказах зарегистрирована в базе данных или обновлена.
Код 401
Ошибка авторизации. Убедитесь, что заголовок запроса содержит правильный OAuth-токен.
Код 403
Ошибка доступа к объекту. У пользователя недостаточно прав для доступа к объекту.
Код 404
Ошибка поиска объекта. Объект не найден.
Код 422
Неверный ввод. Операция не может быть выполнена.
Код 504
Ошибка при работе с API. Повторите запрос.