Получает несколько складов

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

Request

GET

https://courier.yandex.ru/api/v1/companies/{company_id}/depots

Path parameters

Name

Description

company_id*

Type: integer<int64>

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

Query parameters

Name

Description

number

Type: string

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

page

Type: integer

Номер страницы в базе данных. Каждая страница содержит 1000 складов, организованных в порядке возрастания ID склада.

Default: 1

Min value: 1

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
    }
]

Depot[]

Depot

Name	Description
address	Type: string Адрес склада в текстовом формате.
allow_manual_depot_detection	Type: boolean Указывает, разрешена этого склада ручная детекция посещения складов.
allow_manual_order_detection	Type: boolean Указывает, разрешена этого склада ручная детекция посещения заказов.
allow_route_editing	Type: boolean Флаг, который указывает, что курьеры могут редактировать свои маршруты. Default:
description	Type: string Описание склада. Max length: `1023`
id	Type: integer ID склада, используемый в запросах к API Мониторинга.
lat	Type: number<float> Широта точки расположения склада.
lon	Type: number<float> Долгота точки расположения склада. Запрос на добавление нового склада должен содержать параметры lat и lon. Запросы на обновление склада могут опускать оба параметра lat и lon, но не один из них.
mark_delivered_radius	Type: number<float> Радиус в метрах. Если `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 метров от местоположения заказа. Default: `null` Min value: `0` Max value: `10000`
mark_route_started_radius	Type: integer Минимальное расстояние между курьером и складом, при котором отправляется СМС-сообщение о начале смены.
name	Type: string Название склада. Max length: `80`
number	Type: string Номер склада. Используется для синхронизации с учетной системой компании, выполняющей доставку.
order_service_duration_s	Type: integer Дополнительное время, потраченное на отправку конкретного заказа на складе, в секундах. Общая продолжительность обслуживания рассчитывается сложением `service_duration_s` с `order_service_duration_s`. Сумма умножается на количество заказов.
service_duration_s	Type: integer Время, затраченное на отправку товара на складе, в секундах. Это время не зависит от времени, необходимого для загрузки заказов. Общая продолжительность обслуживания рассчитывается сложением `service_duration_s` с `order_service_duration_s`. Сумма умножается на количество заказов.
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

У вас нет доступа к этому объекту.

422 Unprocessable Entity

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

504 Gateway Timeout

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

Was the article helpful?

Обзор

Добавляет склад