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

POST /v1/product/stock/info

POST/v1/product/stock/info

Метод возвращает остатки товаров.

Тело запроса

filter
object
required

Фильтр. Если поле фильтра не передано, равно null или передан пустой массив [], фильтрация по этому полю не применяется. При одновременном указании нескольких фильтров условия объединяются по AND.

Показать свойства
is_archived
boolean

Фильтр по архиву: true — только архивные, false — только неархивные.

location_id
array

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

offer_id
array

Фильтр по артикулам продавца.

product_id
array

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

cursor
string

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

limit
integer
required

Размер страницы. min = 1; max = 300; default = 100.

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

200A successful response.
application/json
object
stocks
array
required

Элементы списка. Остатки с недоступными или несуществующими product_id в ответ не возвращаются.

Если вернулись оба поля product_id и offer_id, приоритетным считается product_id.

Показать свойства
product_id
string

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

offer_id
string

Артикул продавца.

location_id
string
required

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

count
integer
required

Остаток, загруженный продавцом (последнее переданное значение).

available_count
integer

Доступный остаток, вычисленный витриной.

Может не возвращаться или возвращаться null, тогда считать count актуальным остатком для площадки. Вычисление available_count обновляется в случае очередного обновления остатка.

next_cursor
string

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

total
integer

Общее количество записей.

Ошибки

400Некорректный запрос
application/json
object
error_type
string

Класс транспортной ошибки запроса (HTTP 4xx/5xx).

Поэлементные и бизнес-ошибки сущности приходят в HTTP 200 в errors/failed, не в этом поле.

  • ERROR_TYPE_UNSPECIFIED: не используется
  • ERROR_TYPE_UNAUTHORIZED: HTTP 401
  • ERROR_TYPE_RATE_LIMIT: HTTP 429
  • ERROR_TYPE_INTERNAL: HTTP 500
  • ERROR_TYPE_BAD_REQUEST: HTTP 400 (уровень запроса)
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNALERROR_TYPE_BAD_REQUEST
code
string

Машинный код ошибки. Уточняет error_type.

message
string

Человекочитаемое сообщение об ошибке.

details
object
401Ошибка авторизации
application/json
object
error_type
string

Класс транспортной ошибки запроса (HTTP 4xx/5xx).

Поэлементные и бизнес-ошибки сущности приходят в HTTP 200 в errors/failed, не в этом поле.

  • ERROR_TYPE_UNSPECIFIED: не используется
  • ERROR_TYPE_UNAUTHORIZED: HTTP 401
  • ERROR_TYPE_RATE_LIMIT: HTTP 429
  • ERROR_TYPE_INTERNAL: HTTP 500
  • ERROR_TYPE_BAD_REQUEST: HTTP 400 (уровень запроса)
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNALERROR_TYPE_BAD_REQUEST
code
string

Машинный код ошибки. Уточняет error_type.

message
string

Человекочитаемое сообщение об ошибке.

details
object
429Превышен лимит запросов
application/json
object
error_type
string

Класс транспортной ошибки запроса (HTTP 4xx/5xx).

Поэлементные и бизнес-ошибки сущности приходят в HTTP 200 в errors/failed, не в этом поле.

  • ERROR_TYPE_UNSPECIFIED: не используется
  • ERROR_TYPE_UNAUTHORIZED: HTTP 401
  • ERROR_TYPE_RATE_LIMIT: HTTP 429
  • ERROR_TYPE_INTERNAL: HTTP 500
  • ERROR_TYPE_BAD_REQUEST: HTTP 400 (уровень запроса)
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNALERROR_TYPE_BAD_REQUEST
code
string

Машинный код ошибки. Уточняет error_type.

message
string

Человекочитаемое сообщение об ошибке.

details
object
500Внутренняя ошибка сервера
application/json
object
error_type
string

Класс транспортной ошибки запроса (HTTP 4xx/5xx).

Поэлементные и бизнес-ошибки сущности приходят в HTTP 200 в errors/failed, не в этом поле.

  • ERROR_TYPE_UNSPECIFIED: не используется
  • ERROR_TYPE_UNAUTHORIZED: HTTP 401
  • ERROR_TYPE_RATE_LIMIT: HTTP 429
  • ERROR_TYPE_INTERNAL: HTTP 500
  • ERROR_TYPE_BAD_REQUEST: HTTP 400 (уровень запроса)
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNALERROR_TYPE_BAD_REQUEST
code
string

Машинный код ошибки. Уточняет error_type.

message
string

Человекочитаемое сообщение об ошибке.

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

A successful response.