Информация об остатках и оборачиваемости
Возвращает данные об остатках товаров (для всех моделей) и об оборачиваемости товаров (для модели FBY).
По умолчанию данные по оборачивамости не возращаются
Чтобы они были в ответе, передавайте true
в поле withTurnover
.
⚙️ Лимит: 100 000 товаров в минуту |
---|
Request
POST
https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers/stocks
Path parameters
Name |
Type |
Description |
campaignId* |
integer<int64> |
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. |
Query parameters
Name |
Type |
Description |
page_token |
string |
Идентификатор страницы c результатами. Если параметр не указан, возвращается самая старая страница. Рекомендуется передавать значение выходного параметра Если задан |
limit |
integer<int32> |
Количество товаров на одной странице.
|
Body
{
"withTurnover": false,
"archived": false,
"offerIds": [
"string"
]
}
Name |
Type |
Description |
withTurnover |
boolean |
Возвращать ли информацию по оборачиваемости (FBY). Значение по умолчанию —
|
archived |
boolean |
Фильтр по нахождению в архиве. Передайте |
offerIds |
string[] |
Фильтр по вашим SKU товаров. Возвращается информация об остатках всех переданных SKU, включая товары в архиве. Такой список возвращается только целиком Если вы запрашиваете информацию по конкретным SKU, не заполняйте:
Разрешена любая последовательность длиной до 80 знаков. В нее могут входить английские и русские буквы, цифры и символы Правила использования SKU:
Что такое SKU и как его назначать
|
Responses
200 OK
Остатки товаров на складах.
Body
{
"status": "OK",
"result": {
"paging": {
"nextPageToken": "string",
"prevPageToken": "string"
},
"warehouses": [
{
"warehouseId": 0,
"offers": [
{
"offerId": "string",
"turnoverSummary": {
"turnover": "LOW",
"turnoverDays": 0
},
"stocks": [
{
"type": "FIT",
"count": 0
}
],
"updatedAt": "2022-12-29T18:02:01Z"
}
]
}
]
}
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
result |
Список складов с информацией об остатках на каждом из них. |
GetWarehouseStocksDTO
Список складов с информацией об остатках на каждом из них.
Name |
Type |
Description |
paging |
Информация о страницах результатов. |
|
warehouses |
Страница списка складов. |
ScrollingPagerDTO
Информация о страницах результатов.
Name |
Type |
Description |
nextPageToken |
string |
Идентификатор следующей страницы результатов. |
prevPageToken |
string |
Идентификатор предыдущей страницы результатов. |
WarehouseOffersDTO
Информация об остатках товаров на складе.
Name |
Type |
Description |
warehouseId* |
integer<int64> |
Идентификатор склада. |
offers* |
Информация об остатках. |
WarehouseOfferDTO
Информация об остатках товара.
Name |
Type |
Description |
offerId* |
string |
Ваш SKU — идентификатор товара в вашей системе. Разрешена любая последовательность длиной до 80 знаков. В нее могут входить английские и русские буквы, цифры и символы Правила использования SKU:
Что такое SKU и как его назначать
|
turnoverSummary |
Информация об оборачиваемости. |
|
stocks |
Информация об остатках. |
|
updatedAt |
string<date-time> |
Дата и время последнего обновления информации об остатках. Формат даты и времени: ISO 8601 со смещением относительно UTC. Например, |
TurnoverDTO
Информация об оборачиваемости товара.
Name |
Type |
Description |
turnover* |
Оценка оборачиваемости.
|
|
turnoverDays |
number<double> |
Значение в днях. Что это за число? |
WarehouseStockDTO
Информация об остатках товара.
Name |
Type |
Description |
type* |
Тип остатков.
|
|
count* |
integer<int64> |
Значение остатков. |
TurnoverType
Оценка оборачиваемости.
enum | Диапазон оборачиваемости | Комментарий |
---|---|---|
LOW |
turnoverDays ≥ 120 |
|
ALMOST_LOW |
100 ≤ turnoverDays < 120 |
|
HIGH |
45 ≤ turnoverDays < 100 |
|
VERY_HIGH |
0 ≤ turnoverDays < 45 |
|
NO_SALES |
— | Продаж нет. |
FREE_STORE |
Любое значение. | Товары этой категории сейчас хранятся бесплатно. |
Type |
Description |
Enum: |
WarehouseStockType
Тип остатков товаров на складе:
-
AVAILABLE
(соответствует типу «Доступный к заказу» в отчете «Остатки на складе» в кабинете продавца на Маркете) — товар, доступный для продажи. -
DEFECT
(соответствует типу «Брак») — товар с браком. -
EXPIRED
(соответствует типу «Просрочен») — товар с истекшим сроком годности. -
FIT
(соответствует типу «Годный») — товар, который доступен для продажи или уже зарезервирован. -
FREEZE
— товар, который зарезервирован для заказов. -
QUARANTINE
(соответствует типу «Карантин») — товар, временно недоступный для продажи (например, товар перемещают из одного помещения склада в другое). -
UTILIZATION
— товар, который будет утилизирован.
Type |
Description |
Enum: |
400 Bad Request
Запрос содержит неправильные данные.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
errors |
Список ошибок. |
ApiErrorDTO
Общий формат ошибки.
Name |
Type |
Description |
code* |
string |
Код ошибки. |
message |
string |
Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
errors |
Список ошибок. |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
errors |
Список ошибок. |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
errors |
Список ошибок. |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
errors |
Список ошибок. |
Среднее количество дней, за которое товар продается. Подробно об оборачиваемости рассказано в Справке.