Перейти к содержимому
Omninet

Список полигонов с фильтрами и пагинацией

POST /v1/polygon/list

Тело запроса

Заголовок раздела «Тело запроса»
filter object
Фильтр.
Показать Скрыть
location_id array
Фильтр по идентификаторам склада (опционально).
polygon_id array
Фильтр по идентификаторам полигона (опционально).
status array
Фильтр по статусам полигона (опционально).
DRAFT: создан.
PENDING: в обработке.
ACTIVE: активен.
FAILED: не прошёл модерацию.
DELETED: удален.
cursor string
Курсор начала отсчёта.
limit integer
Лимит записей.

Успешный ответ

200 A successful response.
application/json
object
polygons array
Элементы списка.
Показать Скрыть
polygon_id string
Идентификатор полигона.
location_id string
Идентификатор склада.
name string
Название полигона.
status string
Статус полигона.
DRAFT: создан.
PENDING: в обработке.
ACTIVE: активен.
FAILED: не прошёл модерацию.
DELETED: удален.
values
DRAFTPENDINGACTIVEFAILEDDELETED
issue object
Текущая проблема по полигону.
Пустой объект или не передаётся при статусах DRAFT, ACTIVE и DELETED.
Показать Скрыть
code string
Код проблемы.
message string
Детальное описание проблемы.
changed_at string
Момент изменения (RFC3339, например 2026-04-16T08:00:00Z).
delivery_options array
Список цен доставки по объёмному весу.
Опция доставки по диапазону объёмного веса.
Показать Скрыть
volume_weight_from number
Объёмный вес (кг) от: длина (см) × ширина (см) × высота (см) * масса брутто (кг) / 300.
volume_weight_to number
Объёмный вес (кг) до: длина (см) × ширина (см) × высота (см) * масса брутто (кг) / 300.
price number
Цена доставки.
vat string
НДС.
values
VAT_0VAT_5VAT_7VAT_22NO_VAT
provider_id string
Идентификатор провайдера доставки (опционально).
values
CDEKBOXBERRY5POSTRUSSIAN_POSTYANDEXSBLMVIDEO
delivery_time_minutes integer
Время доставки в минутах.
delivery_types array
Типы доставки.
Параметры типа доставки для опции.
Показать Скрыть
delivery_type string required
Тип доставки.
values
COURIERPICKUP_POINT
weight_from number
Вес (кг) от.
weight_to number
Вес (кг) до.
time_slots array
Доступные интервалы доставки по времени (опционально).
Интервал времени доставки в течение дня (локальное время).
Показать Скрыть
from string
Начало интервала, формат «HH:MM» (например, «10:00»).
to string
Конец интервала, формат «HH:MM» (например, «12:00»).
trunk_schedule object
График магистральной перевозки по городу; если не заполнен — не применяется.
Показать Скрыть
working_schedule array
Расписание по дням недели; в каждом элементе — day и shipping_cutoff для магистрали.
Показать Скрыть
day string
День недели.
values
MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY
shipping_cutoff string
Время, после которого отсчёт слота доставки начнётся со следующего дня магистральной перевозки. Формат «16:30». Если пустое — не применяется.
individual_schedule array
Индивидуальное расписание на даты; в каждом элементе — date, shipping_cutoff для магистрали, is_works.
Показать Скрыть
date string
Дата, формат «YYYY-MM-DD».
shipping_cutoff string
Время, после которого отсчёт слота доставки начнётся со следующего дня магистральной перевозки. Формат «16:30». Если пустое — не применяется.
is_works boolean
Признак работы в дату.
coordinates array
Контур полигона в формате RFC 7946: массив линейных колец В JSON передаётся как массив линейных колец: первое кольцо — внешняя граница, последующие — отверстия. Позиция задаётся как [долгота(longitude), широта(latitude)] в градусах, система координат WGS 84 (долгота первой компонентой). Пример: [[[37.61, 55.75], [37.62, 55.76]], [[37.70, 55.80], [37.71, 55.81]]].
Линейное кольцо (LinearRing).
next_cursor string
Курсор начала отсчёта.
total integer
Общее количество записей.

Ошибки

400 Некорректный запрос
application/json
object
error_type string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
values
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code string
код ошибки
message string
сообщение
details object
Показать Скрыть
No properties defined
401 Ошибка авторизации
application/json
object
error_type string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
values
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code string
код ошибки
message string
сообщение
details object
Показать Скрыть
No properties defined
429 Превышен лимит запросов
application/json
object
error_type string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
values
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code string
код ошибки
message string
сообщение
details object
Показать Скрыть
No properties defined
500 Внутренняя ошибка сервера
application/json
object
error_type string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
values
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code string
код ошибки
message string
сообщение
details object
Показать Скрыть
No properties defined
POST /v1/polygon/list 

              1
              curl https://api.omninet.ru/v1/polygon/list \
            
              2
                --request POST \
            
              3
                --header 'Content-Type: application/json' \
            
              4
                --data '{
            
              5
                "filter": {
            
              6
                  "location_id": [
            
              7
                    "string"
            
              8
                  ],
            
              9
                  "polygon_id": [
            
              10
                    "string"
            
              11
                  ],
            
              12
                  "status": [
            
              13
                    "string"
            
              14
                  ]
            
              15
                },
            
              16
                "cursor": "string",
            
              17
                "limit": 0
            
              18
              }'
            
{
  "polygons": [
    {
      "polygon_id": "string",
      "location_id": "string",
      "name": "string",
      "status": "string",
      "issue": {
        "code": "string",
        "message": "string",
        "changed_at": "string"
      },
      "delivery_options": [
        {
          "volume_weight_from": 0,
          "volume_weight_to": 0,
          "price": 0,
          "vat": "string",
          "provider_id": "string",
          "delivery_time_minutes": 0,
          "delivery_types": [
            {
              "delivery_type": "COURIER"
            }
          ],
          "weight_from": 0,
          "weight_to": 0,
          "time_slots": [
            {
              "from": "string",
              "to": "string"
            }
          ],
          "trunk_schedule": {
            "working_schedule": [
              {
                "day": "MONDAY",
                "shipping_cutoff": "string"
              }
            ],
            "individual_schedule": [
              {
                "date": "string",
                "shipping_cutoff": "string",
                "is_works": true
              }
            ]
          }
        }
      ],
      "coordinates": [
        [
          [
            100,
            0
          ],
          [
            101,
            0
          ],
          [
            101,
            1
          ],
          [
            100,
            1
          ],
          [
            100,
            0
          ]
        ]
      ]
    }
  ],
  "next_cursor": "string",
  "total": 0
}

A successful response.

{
  "error_type": "string",
  "code": "string",
  "message": "string",
  "details": {}
}

Некорректный запрос

{
  "error_type": "string",
  "code": "string",
  "message": "string",
  "details": {}
}

Ошибка авторизации

{
  "error_type": "string",
  "code": "string",
  "message": "string",
  "details": {}
}

Превышен лимит запросов

{
  "error_type": "string",
  "code": "string",
  "message": "string",
  "details": {}
}

Внутренняя ошибка сервера