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

  1. HTTP-запрос
  2. Path-параметры
  3. Query-параметры
  4. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 401
    3. Код 403
    4. Код 404
    5. Код 422
    6. Код 504

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

HTTP-запрос

DELETE https://courier.yandex.ru/api/v1/companies/{company_id}/depots/{depot_id}\
?shallow_delete={boolean}

Path-параметры

company_id *

integer

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

depot_id *

integer

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

company_id *

integer

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

depot_id *

integer

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

Query-параметры

shallow_delete

boolean

Если true помечает склад удалённым, не затрагивая зависимые объекты.

shallow_delete

boolean

Если true помечает склад удалённым, не затрагивая зависимые объекты.

Ответы

Код 200

Информация о складе удалена.

{
  "address": string,
  "allow_manual_depot_detection": boolean,
  "allow_manual_order_detection": boolean,
  "allow_route_editing": boolean,
  "description": string,
  "id": integer,
  "lat": number,
  "lon": number,
  "mark_delivered_radius": number,
  "mark_route_started_radius": integer,
  "name": string,
  "number": string,
  "order_service_duration_s": integer,
  "service_duration_s": integer,
  "time_interval": string,
  "time_zone": string
}
Скопировано

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

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

Поля

address

string

Адрес склада в текстовом формате.

allow_manual_depot_detection

boolean

Указывает, разрешена этого склада ручная детекция посещения складов.

allow_manual_order_detection

boolean

Указывает, разрешена этого склада ручная детекция посещения заказов.

allow_route_editing

boolean

Флаг, который указывает, что курьеры могут редактировать свои маршруты.

description

string

Описание склада.

id

integer

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

lat

number

Широта точки расположения склада.

lon

number

Долгота точки расположения склада. Запрос на добавление нового склада должен содержать параметры lat и lon. Запросы на обновление склада могут опускать оба параметра lat и lon, но не один из них.

mark_delivered_radius

number

Радиус в метрах. Если null, используется 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.

mark_route_started_radius

integer

Минимальное расстояние между курьером и складом, при котором отправляется СМС-сообщение о начале смены.

name

string

Название склада.

number

string

Номер склада. Используется для синхронизации с учетной системой компании, выполняющей доставку.

order_service_duration_s

integer

Дополнительное время, потраченное на отправку конкретного заказа на складе, в секундах. Общая продолжительность обслуживания рассчитывается сложением service_duration_s с order_service_duration_s. Сумма умножается на количество заказов.

service_duration_s

integer

Время, затраченное на отправку товара на складе, в секундах. Это время не зависит от времени, необходимого для загрузки заказов. Общая продолжительность обслуживания рассчитывается сложением service_duration_s с order_service_duration_s. Сумма умножается на количество заказов.

time_interval

string

Часы работы склада в формате "T - T" или "T-T", где T - время в формате HH, HH:MM, HH:MM:SS или [d.]HH:MM:SS .

time_zone

string

Часовой пояс склада в формате базы данных tz, например Europe/Moscow, Europe/Berlin, Asia/Irkutsk, Asia/Istanbul. Дополнительные примеры доступны по адресу https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. По умолчанию часовой пояс склада рассчитывается на основе его координат.

address

string

Адрес склада в текстовом формате.

allow_manual_depot_detection

boolean

Указывает, разрешена этого склада ручная детекция посещения складов.

allow_manual_order_detection

boolean

Указывает, разрешена этого склада ручная детекция посещения заказов.

allow_route_editing

boolean

Флаг, который указывает, что курьеры могут редактировать свои маршруты.

description

string

Описание склада.

id

integer

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

lat

number

Широта точки расположения склада.

lon

number

Долгота точки расположения склада. Запрос на добавление нового склада должен содержать параметры lat и lon. Запросы на обновление склада могут опускать оба параметра lat и lon, но не один из них.

mark_delivered_radius

number

Радиус в метрах. Если null, используется 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.

mark_route_started_radius

integer

Минимальное расстояние между курьером и складом, при котором отправляется СМС-сообщение о начале смены.

name

string

Название склада.

number

string

Номер склада. Используется для синхронизации с учетной системой компании, выполняющей доставку.

order_service_duration_s

integer

Дополнительное время, потраченное на отправку конкретного заказа на складе, в секундах. Общая продолжительность обслуживания рассчитывается сложением service_duration_s с order_service_duration_s. Сумма умножается на количество заказов.

service_duration_s

integer

Время, затраченное на отправку товара на складе, в секундах. Это время не зависит от времени, необходимого для загрузки заказов. Общая продолжительность обслуживания рассчитывается сложением service_duration_s с order_service_duration_s. Сумма умножается на количество заказов.

time_interval

string

Часы работы склада в формате "T - T" или "T-T", где T - время в формате HH, HH:MM, HH:MM:SS или [d.]HH:MM:SS .

time_zone

string

Часовой пояс склада в формате базы данных tz, например Europe/Moscow, Europe/Berlin, Asia/Irkutsk, Asia/Istanbul. Дополнительные примеры доступны по адресу https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. По умолчанию часовой пояс склада рассчитывается на основе его координат.

Код 401

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

Код 403

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

Код 404

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

Код 422

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

Код 504

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