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

Получение остатков товаров

POST /v1/product/stock/info

Тело запроса

Заголовок раздела «Тело запроса»
filter object
Фильтр.
Показать Скрыть
product_id array
Фильтр по идентификаторам товара (опционально).
offer_id array
Фильтр по артикулам продавца (опционально).
location_id array
Фильтр по идентификаторам склада (опционально).
is_archived boolean
Фильтр по архиву: true — только архивные, false — только неархивные (опционально).
cursor string
Курсор начала отсчёта.
limit integer
Лимит записей.

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

200 A successful response.
application/json
object
stocks array
Элементы списка.
Идентификаторы offer_id и product_id используются с приоритезацией.
Если заполнены оба идентификатора, то используется только offer_id.
Показать Скрыть
product_id string
Идентификатор товара.
offer_id string
Артикул продавца.
location_id string
Идентификатор склада.
count integer
Остаток, загруженный продавцом (последнее переданное значение).
available_count integer
Доступный остаток, вычисленный витриной.
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/product/stock/info 

              1
              curl https://api.omninet.ru/v1/product/stock/info \
            
              2
                --request POST \
            
              3
                --header 'Content-Type: application/json' \
            
              4
                --data '{
            
              5
                "filter": {
            
              6
                  "product_id": [
            
              7
                    "string"
            
              8
                  ],
            
              9
                  "offer_id": [
            
              10
                    "string"
            
              11
                  ],
            
              12
                  "location_id": [
            
              13
                    "string"
            
              14
                  ],
            
              15
                  "is_archived": true
            
              16
                },
            
              17
                "cursor": "string",
            
              18
                "limit": 0
            
              19
              }'
            
{
  "stocks": [
    {
      "product_id": "string",
      "offer_id": "string",
      "location_id": "string",
      "count": 0,
      "available_count": 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": {}
}

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