Список складов маркетплейса, доступных для отгрузок

POST /v1/market/location/list

POST/v1/market/location/list

Тело запроса

filter
object
Параметры фильтрации складов маркетплейса.
Показать свойства
city
array
Фильтр по городам расположения склада маркетплейса (опционально).
is_active
boolean
Фильтр по доступности склада для новых FBS-поставок (опционально).
accepts_kgt
boolean
Вернуть только склады, принимающие КГТ-отгрузки (опционально).
accepts_mgt
boolean
Вернуть только склады, принимающие МГТ-отгрузки (опционально).
market_location_ids
array
Фильтр по идентификаторам складов маркетплейса (опционально).
cursor
string
Курсор постраничной выборки.
limit
integer
Размер страницы. min = 1; max = 300; default = 100.

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

200A successful response.
application/json
object
locations
array
Список складов маркетплейса, доступных для подключения.
marketLocationListItem
Показать свойства
marketLocationListItem
market_location_id
string
Идентификатор склада маркетплейса.
name
string
Название склада маркетплейса.
city
string
Город расположения склада маркетплейса.
address_tail
string
Краткий адрес склада.
timezone
string
Часовой пояс склада маркетплейса.
is_active
boolean
Признак активности склада.
acceptance_schedule
array
Расписание приёмки отгрузок на складе маркетплейса.
marketLocationWorkingSchedule
Показать свойства
marketLocationWorkingSchedule
day
string
День недели.
Допустимые значения
MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY
schedule
object
Расписание на день.
Показать свойства
start_time
string
Время начала приемки в формате HH:MM.
end_time
string
Время окончания приемки в формате HH:MM.
shipment_limits
object
Ограничения склада маркетплейса по типам и габаритам отгрузок.
Показать свойства
accepts_standard
boolean
Склад принимает стандартные FBS-отгрузки.
accepts_kgt
boolean
Склад принимает КГТ-отгрузки.
accepts_mgt
boolean
Склад принимает МГТ-отгрузки.
max_weight_kg
number
Максимальный вес одного грузоместа в килограммах.
max_length_cm
number
Максимальная длина одного грузоместа в сантиметрах.
max_width_cm
number
Максимальная ширина одного грузоместа в сантиметрах.
max_height_cm
number
Максимальная высота одного грузоместа в сантиметрах.
max_sum_dimensions_cm
number
Максимальная сумма измерений одного грузоместа в сантиметрах.
comment
string
Дополнительный комментарий по ограничениям отгрузки.
acceptance_instructions
string
Краткая инструкция продавцу по подготовке отгрузки на выбранный склад.
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
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string
сообщение
details
object
401Ошибка авторизации
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string
сообщение
details
object
429Превышен лимит запросов
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string
сообщение
details
object
500Внутренняя ошибка сервера
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string
сообщение
details
object
defaultОшибка (неожиданная или прочие)
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string
сообщение
details
object
POST/v1/market/location/list
1curl https://api.omninet.ru/v1/market/location/list \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "filter": {6    "city": [7      "string"8    ],9    "is_active": true,10    "accepts_kgt": true,11    "accepts_mgt": true,12    "market_location_ids": [13      "string"14    ]15  },16  "cursor": "string",17  "limit": 018}'
{
  "locations": [
    {
      "market_location_id": "string",
      "name": "string",
      "city": "string",
      "address_tail": "string",
      "timezone": "string",
      "is_active": true,
      "acceptance_schedule": [
        {
          "day": "MONDAY",
          "schedule": {
            "start_time": "string",
            "end_time": "string"
          }
        }
      ],
      "shipment_limits": {
        "accepts_standard": true,
        "accepts_kgt": true,
        "accepts_mgt": true,
        "max_weight_kg": 0,
        "max_length_cm": 0,
        "max_width_cm": 0,
        "max_height_cm": 0,
        "max_sum_dimensions_cm": 0,
        "comment": "string"
      },
      "acceptance_instructions": "string"
    }
  ],
  "next_cursor": "string",
  "total": 0
}

A successful response.