Добавляет заказ
Добавляет информацию о заказе в базу данных.
HTTP-запрос
POST https://courier.yandex.ru/api/v1/companies/{company_id}/orders
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_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 ], "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_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 Номера компаний, которые могут получить доступ к информации о заказе. Предоставляется следующая информация:
|
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_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 Номера компаний, которые могут получить доступ к информации о заказе. Предоставляется следующая информация:
|
status | string Текущий статус заказа. Возможные значения:
|
time_interval * | string Желаемое окно доставки заказа. Поддерживаются следующие форматы:
|
type | string Тип заказа. Возможные значения |
volume | number Объем заказа. |
weight | number Вес заказа. |
x-description-en | string Описание заказа. |
* Обязательный параметр
Ответы
Код 200
Информация о заказе зарегистрирована в базе данных.
{ "address": string, "amount": number, "comments": string, "company_id": integer, "confirmed_at": string, "customer_name": string, "delivered_at": string, "eta_type": string, "history": [ { "event": string, "position": { "lat": number, "lon": number, "time": string }, "source": { "initiator": string }, "time": string, "timestamp": number, "used_mark_delivered_radius": number } ], "id": integer, "lat": number, "lon": number, "mark_delivered_radius": number, "number": string, "order_status_comments": [ { "comment": string, "id": integer, "status": string } ], "payment_type": string, "phone": string, "refined_lat": number, "refined_lon": number, "route_id": integer, "service_duration_s": integer, "shared_service_duration_s": integer, "shared_with_companies": [ { "id": integer, "name": string, "number": string } ], "shared_with_company_ids": [ number ], "status": string, "status_log": [ { "point": { "lat": number, "lon": number }, "status": string, "timestamp": number } ], "time_interval": string, "time_interval_secs": [ number ], "time_window": { "end": string, "start": string }, "volume": number, "weight": number, "x-description-en": string }
Скопировано
Представление
Поля
address * | string Адрес доставки в текстовом формате. |
amount | number Стоимость заказа в рублях. |
comments | string Комментарии к заказу. |
company_id | integer ID компании, используемый в запросах к API Мониторинга. |
confirmed_at | string Время, когда заказ был согласован. |
customer_name | string Имя заказчика. |
delivered_at | string Время, когда информация о выполнении заказа была зафиксирована в системе Яндекс.Курьер. |
eta_type | string Тип ETA. Влияет на время оповещения и автоматического определения доставки. |
history[] | array История событий, изменяющих статус заказа. |
history[]. | string Название случившегося события. Возможные значения: ORDER_CREATED, START, ORDER_BECAME_NEXT, STATUS_UPDATE, INTERVAL_UPDATE, ARRIVAL, ORDER_VISIT, DEPARTURE. |
history[]. | object Позиция курьера. Появляется только в событиях ARRIVAL, ORDER_VISIT, DEPARTURE. |
history[]. | number Широта позиции курьера. |
history[]. | number Долгота позиции курьера. |
history[]. | string Время события на клиенте в формате ISO 8601. |
history[]. | object Источник события. Отображается только в событии STATUS_UPDATE. |
history[]. | string Инициатор события, возможные значения: yandex, app, user_api. |
history[]. | string Время события в формате ISO 8601. |
history[]. | number Время события (UNIX-формат). |
history[]. | number Значение order.mark_delivered_radius или depot.mark_delivered_radius или company.mark_delivered_radius, которое использовалось для пометки заказа как посещенного. Только для событий ARRIVAL, ORDER_VISIT, DEPARTURE. Минимальное значение: |
id | integer ID заказа, используемый в запросах к API Мониторинга. |
lat * | number Широта точки доставки. |
lon * | number Долгота точки доставки. |
mark_delivered_radius | number Радиус в метрах. Если Минимальное значение: |
number * | string Номер заказа. Используется для синхронизации с учетной системой компании, выполняющей доставку. |
order_status_comments[] | array |
order_status_comments[]. | string Комментарий к событию обновления статуса заказа. |
order_status_comments[]. | integer ID события обновления статуса заказа. |
order_status_comments[]. | string Текущий статус заказа. Возможные значения:
|
payment_type | string Тип оплаты. Возможные значения:
|
phone | string Телефон получателя. |
refined_lat | number Широта реальной (уточнённой курьером) точки доставки. |
refined_lon | number Долгота реальной (уточнённой курьером) точки доставки. |
route_id | integer ID маршрута, используемый в запросах к API Мониторинга. |
service_duration_s | integer Ожидаемое время, потраченное курьером на отгрузку товара получателю, в том числе чтобы подняться на этаж и получить оплату. |
shared_service_duration_s | integer Продолжительность обслуживания в точке доставки, которая может быть разделена с другими заказами в том же месте. |
shared_with_companies[] | array |
shared_with_companies[]. | string Название компании. |
shared_with_companies[]. | string Номер компании. |
shared_with_companies[]. | integer ID компании, используемый в запросах к API Мониторинга. |
shared_with_company_ids[] | array ID компаний, которые могут получить доступ к информации о заказе. Предоставляется следующая информация:
|
status | string Текущий статус заказа. Возможные значения:
|
status_log[] | array |
status_log[]. | object |
status_log[]. | number Широта точки внесения изменений. |
status_log[]. | number Долгота точки внесения изменений. |
status_log[]. | string Текущий статус заказа. Возможные значения:
|
status_log[]. | number UNIX timestamp времени внесения изменений. |
time_interval * | string Желаемое окно доставки заказа. Поддерживаются следующие форматы:
|
time_interval_secs[] | array значение |
time_window | object Допустимое окно доставки заказа в формате ISO 8601. |
time_window. | string |
time_window. | string |
volume | number Объем заказа. |
weight | number Вес заказа. |
x-description-en | string Описание заказа. |
address * | string Адрес доставки в текстовом формате. |
amount | number Стоимость заказа в рублях. |
comments | string Комментарии к заказу. |
company_id | integer ID компании, используемый в запросах к API Мониторинга. |
confirmed_at | string Время, когда заказ был согласован. |
customer_name | string Имя заказчика. |
delivered_at | string Время, когда информация о выполнении заказа была зафиксирована в системе Яндекс.Курьер. |
eta_type | string Тип ETA. Влияет на время оповещения и автоматического определения доставки. |
history[] | array История событий, изменяющих статус заказа. |
history[]. | string Название случившегося события. Возможные значения: ORDER_CREATED, START, ORDER_BECAME_NEXT, STATUS_UPDATE, INTERVAL_UPDATE, ARRIVAL, ORDER_VISIT, DEPARTURE. |
history[]. | object Позиция курьера. Появляется только в событиях ARRIVAL, ORDER_VISIT, DEPARTURE. |
history[]. | number Широта позиции курьера. |
history[]. | number Долгота позиции курьера. |
history[]. | string Время события на клиенте в формате ISO 8601. |
history[]. | object Источник события. Отображается только в событии STATUS_UPDATE. |
history[]. | string Инициатор события, возможные значения: yandex, app, user_api. |
history[]. | string Время события в формате ISO 8601. |
history[]. | number Время события (UNIX-формат). |
history[]. | number Значение order.mark_delivered_radius или depot.mark_delivered_radius или company.mark_delivered_radius, которое использовалось для пометки заказа как посещенного. Только для событий ARRIVAL, ORDER_VISIT, DEPARTURE. Минимальное значение: |
id | integer ID заказа, используемый в запросах к API Мониторинга. |
lat * | number Широта точки доставки. |
lon * | number Долгота точки доставки. |
mark_delivered_radius | number Радиус в метрах. Если Минимальное значение: |
number * | string Номер заказа. Используется для синхронизации с учетной системой компании, выполняющей доставку. |
order_status_comments[] | array |
order_status_comments[]. | string Комментарий к событию обновления статуса заказа. |
order_status_comments[]. | integer ID события обновления статуса заказа. |
order_status_comments[]. | string Текущий статус заказа. Возможные значения:
|
payment_type | string Тип оплаты. Возможные значения:
|
phone | string Телефон получателя. |
refined_lat | number Широта реальной (уточнённой курьером) точки доставки. |
refined_lon | number Долгота реальной (уточнённой курьером) точки доставки. |
route_id | integer ID маршрута, используемый в запросах к API Мониторинга. |
service_duration_s | integer Ожидаемое время, потраченное курьером на отгрузку товара получателю, в том числе чтобы подняться на этаж и получить оплату. |
shared_service_duration_s | integer Продолжительность обслуживания в точке доставки, которая может быть разделена с другими заказами в том же месте. |
shared_with_companies[] | array |
shared_with_companies[]. | string Название компании. |
shared_with_companies[]. | string Номер компании. |
shared_with_companies[]. | integer ID компании, используемый в запросах к API Мониторинга. |
shared_with_company_ids[] | array ID компаний, которые могут получить доступ к информации о заказе. Предоставляется следующая информация:
|
status | string Текущий статус заказа. Возможные значения:
|
status_log[] | array |
status_log[]. | object |
status_log[]. | number Широта точки внесения изменений. |
status_log[]. | number Долгота точки внесения изменений. |
status_log[]. | string Текущий статус заказа. Возможные значения:
|
status_log[]. | number UNIX timestamp времени внесения изменений. |
time_interval * | string Желаемое окно доставки заказа. Поддерживаются следующие форматы:
|
time_interval_secs[] | array значение |
time_window | object Допустимое окно доставки заказа в формате ISO 8601. |
time_window. | string |
time_window. | string |
volume | number Объем заказа. |
weight | number Вес заказа. |
x-description-en | string Описание заказа. |
* Обязательный параметр
Код 401
Ошибка авторизации. Убедитесь, что заголовок запроса содержит правильный OAuth-токен.
Код 422
Неверный ввод. Операция не может быть выполнена.
Код 504
Ошибка при работе с API. Повторите запрос.
Пример
Responses:
{ "history": [ { "time": "2019-05-27T17:18:52+03:00" } ], "time_window": { "end": "2019-03-06T17:16:30+03:00", "start": "2019-03-06T17:15:00+03:00" } }
Скопировано