Редактирует склад
Обновляет информацию о складе по его ID.
Request
PATCH
https://courier.yandex.ru/api/v1/companies/{company_id}/depots/{depot_id}
Path parameters
|
Name |
Description |
|
company_id* |
Type: integer ID компании, используемый в запросах к API Мониторинга. |
|
depot_id* |
Type: integer ID склада, используемый в запросах к API Мониторинга. |
Body
application/json
{
"address": "string",
"allow_route_editing": false,
"description": "string",
"id": 0,
"lat": 0,
"lon": 0,
"name": "string",
"number": "string",
"order_service_duration_s": 0,
"service_duration_s": 0,
"time_interval": "string",
"time_zone": "string",
"mark_route_started_radius": 0,
"mark_delivered_radius": null,
"allow_manual_order_detection": false,
"allow_manual_depot_detection": false
}
|
Name |
Description |
|
address |
Type: string Адрес склада в текстовом формате. |
|
allow_manual_depot_detection |
Type: boolean Указывает, разрешена этого склада ручная детекция посещения складов. |
|
allow_manual_order_detection |
Type: boolean Указывает, разрешена этого склада ручная детекция посещения заказов. |
|
allow_route_editing |
Type: boolean Флаг, который указывает, что курьеры могут редактировать свои маршруты. |
|
description |
Type: string Описание склада. Max length: |
|
id |
Type: integer ID склада, используемый в запросах к API Мониторинга. |
|
lat |
Type: number<float> Широта точки расположения склада. |
|
lon |
Type: number<float> Долгота точки расположения склада. Запрос на добавление нового склада должен содержать параметры lat и lon. Запросы на обновление склада могут опускать оба параметра lat и lon, но не один из них. |
|
mark_delivered_radius |
Type: number<float> Радиус в метрах. Если Max value: |
|
mark_route_started_radius |
Type: integer Минимальное расстояние между курьером и складом, при котором отправляется СМС-сообщение о начале смены. |
|
name |
Type: string Название склада. Max length: |
|
number |
Type: string Номер склада. Используется для синхронизации с учетной системой компании, выполняющей доставку. |
|
order_service_duration_s |
Type: integer Дополнительное время, потраченное на отправку конкретного заказа на складе, в секундах. Общая продолжительность обслуживания рассчитывается сложением |
|
service_duration_s |
Type: integer Время, затраченное на отправку товара на складе, в секундах. Это время не зависит от времени, необходимого для загрузки заказов. Общая продолжительность обслуживания рассчитывается сложением |
|
time_interval |
Type: string Часы работы склада в формате "T - T" или "T-T", где T - время в формате HH, HH:MM, HH:MM:SS или [d.]HH:MM:SS . |
|
time_zone |
Type: string Часовой пояс склада в формате базы данных tz, например Europe/Moscow, Europe/Berlin, Asia/Irkutsk, Asia/Istanbul. Дополнительные примеры доступны по адресу https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. По умолчанию часовой пояс склада рассчитывается на основе его координат. |
Responses
200 OK
Информация о складе обновлена.
Body
application/json
{
"address": "string",
"allow_route_editing": false,
"description": "string",
"id": 0,
"lat": 0,
"lon": 0,
"name": "string",
"number": "string",
"order_service_duration_s": 0,
"service_duration_s": 0,
"time_interval": "string",
"time_zone": "string",
"mark_route_started_radius": 0,
"mark_delivered_radius": null,
"allow_manual_order_detection": false,
"allow_manual_depot_detection": false
}
|
Name |
Description |
|
address |
Type: string Адрес склада в текстовом формате. |
|
allow_manual_depot_detection |
Type: boolean Указывает, разрешена этого склада ручная детекция посещения складов. |
|
allow_manual_order_detection |
Type: boolean Указывает, разрешена этого склада ручная детекция посещения заказов. |
|
allow_route_editing |
Type: boolean Флаг, который указывает, что курьеры могут редактировать свои маршруты. |
|
description |
Type: string Описание склада. Max length: |
|
id |
Type: integer ID склада, используемый в запросах к API Мониторинга. |
|
lat |
Type: number<float> Широта точки расположения склада. |
|
lon |
Type: number<float> Долгота точки расположения склада. Запрос на добавление нового склада должен содержать параметры lat и lon. Запросы на обновление склада могут опускать оба параметра lat и lon, но не один из них. |
|
mark_delivered_radius |
Type: number<float> Радиус в метрах. Если Max value: |
|
mark_route_started_radius |
Type: integer Минимальное расстояние между курьером и складом, при котором отправляется СМС-сообщение о начале смены. |
|
name |
Type: string Название склада. Max length: |
|
number |
Type: string Номер склада. Используется для синхронизации с учетной системой компании, выполняющей доставку. |
|
order_service_duration_s |
Type: integer Дополнительное время, потраченное на отправку конкретного заказа на складе, в секундах. Общая продолжительность обслуживания рассчитывается сложением |
|
service_duration_s |
Type: integer Время, затраченное на отправку товара на складе, в секундах. Это время не зависит от времени, необходимого для загрузки заказов. Общая продолжительность обслуживания рассчитывается сложением |
|
time_interval |
Type: string Часы работы склада в формате "T - T" или "T-T", где T - время в формате HH, HH:MM, HH:MM:SS или [d.]HH:MM:SS . |
|
time_zone |
Type: string Часовой пояс склада в формате базы данных tz, например Europe/Moscow, Europe/Berlin, Asia/Irkutsk, Asia/Istanbul. Дополнительные примеры доступны по адресу https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. По умолчанию часовой пояс склада рассчитывается на основе его координат. |
401 Unauthorized
Ошибка авторизации. Убедитесь, что заголовок запроса содержит правильный OAuth-токен.
403 Forbidden
Ошибка доступа к объекту. У пользователя недостаточно прав для доступа к объекту.
404 Not Found
Ошибка поиска объекта. Объект не найден.
410 Gone
Объект был удалён.
422 Unprocessable Entity
Неверный ввод. Операция не может быть выполнена.
504 Gateway Timeout
Ошибка при работе с API. Повторите запрос.