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

POST /v1/location/list

Тело запроса

filter object

Фильтр.

Показать Скрыть

status array

Фильтр по статусам локации (опционально). В выборку попадают локации, чей статус входит в указанный набор.

Статус локации в витрине.

- DRAFT: создан.
- PENDING: в обработке.
- ACTIVE: включена, доступна к выбору.
- QUARANTINE: карантин.
- FAILED: не прошёл модерацию.
- ARCHIVED: перенесён в архив.

location_id array

Фильтр по идентификаторам локации (опционально).

location_types array

Фильтр по типам локации (опционально). В выборку попадают локации, у которых в массиве location_types есть хотя бы один из указанных типов (WAREHOUSE, PICKUP_POINT, CLICK_AND_COLLECT).

Тип локации в массиве location_types.

- WAREHOUSE: склад.
- PICKUP_POINT: пункт выдачи.
- CLICK_AND_COLLECT: пункт самовывоза (Click & Collect).

cursor string

Курсор начала отсчёта.

limit integer

Лимит записей.

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

200 A successful response.

application/json

object

locations array

Элементы списка.

Показать Скрыть

location_id string

Идентификатор локации.

merchant_location_id string

Идентификатор локации продавца (опционально).

location_types array

Типы локации; элементы — WAREHOUSE (склад), PICKUP_POINT (пункт выдачи) или CLICK_AND_COLLECT (пункт самовывоза). Набор определяет допустимую схему данных и валидацию полей локации.

Тип локации в массиве location_types.

- WAREHOUSE: склад.
- PICKUP_POINT: пункт выдачи.
- CLICK_AND_COLLECT: пункт самовывоза (Click & Collect).

name string

Название локации.

status string

Статус локации в витрине.

values

DRAFTPENDINGACTIVEQUARANTINEFAILEDARCHIVED

issue object

Проблема по локации; пустой объект или не передаётся при статусах DRAFT и ACTIVE.

Показать Скрыть

code string

Код проблемы.

message string

Детальное описание проблемы.

changed_at string

Момент изменения (RFC3339, например 2026-04-16T08:00:00Z).

address_tail string

Адрес в текстовом формате. Обязателен при delivery_type = COURIER (опционально).

comment string

Комментарий к доставке или адресу (опционально).

latitude number

Широта (опционально).

longitude number

Долгота (опционально).

provider_id string

Идентификатор провайдера доставки (опционально).

values

CDEKBOXBERRY5POSTRUSSIAN_POSTYANDEXSBLMVIDEO

provider_location_id string

Идентификатор локации у провайдера доставки (опционально).

pickup_point_type string

Тип пункта выдачи.

- PICKUP_POINT: пункт выдачи.
- POSTAMAT: постамат.

values

PICKUP_POINTPOSTAMAT

payment_methods array

Доступные способы оплаты на точке (опционально).

Способ оплаты на точке.

- ALREADY_PAID: предоплаченные заказы.
- CARD: оплата картой.
- CASH: оплата наличными.

storage_period_days integer

Число дней хранения заказа на точке (опционально).

limits object

Предельные габариты и вес заказа для точки (ВГХ, см и кг).

Показать Скрыть

length number

Максимальная длина заказа, см.

width number

Максимальная ширина заказа, см.

height number

Максимальная высота заказа, см.

weight number

Максимальный вес заказа, кг.

instruction string

Инструкция как добраться для отображения на витрине (опционально).

pickup_services array

Дополнительные услуги пункта выдачи (опционально).

Дополнительная услуга ПВЗ.

- FITTING: возможна примерка.

working_schedule array

Расписание работы.

Показать Скрыть

day string

День недели.

values

MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY

schedule object

Расписание на день.

Показать Скрыть

time_start string

Время начала, формат «00:00».

time_end string

Время окончания, формат «00:00».

break string

Перерыв, формат «13:00–14:00».

shipping_cutoff string

Время, после которого отсчёт слота доставки начнётся со следующего дня. Формат «16:30». Если пустое — не применяется.

individual_schedule array

Индивидуальное расписание на определённые даты. К примеру, праздничные дни (опционально при отличии от working_schedule).

Показать Скрыть

date string

Дата, формат «YYYY-MM-DD».

schedule object

Расписание на дату.

Показать Скрыть

time_start string

Время начала, формат «00:00».

time_end string

Время окончания, формат «00:00».

break string

Перерыв, формат «13:00–14:00».

shipping_cutoff string

Время, после которого отсчёт слота доставки начнётся со следующего дня. Формат «16:30». Если пустое — не применяется.

is_works boolean

Признак работы в дату.

is_accepts_returns boolean

Признак приёма возвратов.

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/location/list

Copy

              1
              curl https://api.omninet.ru/v1/location/list \
            
              2
                --request POST \
            
              3
                --header 'Content-Type: application/json' \
            
              4
                --data '{
            
              5
                "filter": {
            
              6
                  "status": [
            
              7
                    "string"
            
              8
                  ],
            
              9
                  "location_id": [
            
              10
                    "string"
            
              11
                  ],
            
              12
                  "location_types": [
            
              13
                    "string"
            
              14
                  ]
            
              15
                },
            
              16
                "cursor": "string",
            
              17
                "limit": 0
            
              18
              }'
            

200 400 401 429 500

{
  "locations": [
    {
      "location_id": "string",
      "merchant_location_id": "string",
      "location_types": [
        "string"
      ],
      "name": "string",
      "status": "string",
      "issue": {
        "code": "string",
        "message": "string",
        "changed_at": "string"
      },
      "address_tail": "string",
      "comment": "string",
      "latitude": 0,
      "longitude": 0,
      "provider_id": "string",
      "provider_location_id": "string",
      "pickup_point_type": "string",
      "payment_methods": [
        "string"
      ],
      "storage_period_days": 0,
      "limits": {
        "length": 0,
        "width": 0,
        "height": 0,
        "weight": 0
      },
      "instruction": "string",
      "pickup_services": [
        "string"
      ],
      "working_schedule": [
        {
          "day": "MONDAY",
          "schedule": {
            "time_start": "string",
            "time_end": "string",
            "break": "string",
            "shipping_cutoff": "string"
          }
        }
      ],
      "individual_schedule": [
        {
          "date": "string",
          "schedule": {
            "time_start": "string",
            "time_end": "string",
            "break": "string",
            "shipping_cutoff": "string"
          },
          "is_works": true
        }
      ],
      "is_accepts_returns": true
    }
  ],
  "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": {}
}

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