Отчёты (reports)

Отчеты по товарам, удержаниям, платной приемке и платному хранению

Отчёты

Отчеты по товарам, удержаниям, платной приемке и платному хранению

Отчёты по товарам

Для доступа к методам используйте токен для категории Статистика
Отчёты можно сохранять в Excel

Поставки{{ /api/v1/supplier/incomes }}

Описание метода
Максимум 1 запрос в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Дата и время последнего изменения по поставке.
Дата в формате RFC3339. Можно передать дату или дату со временем. Время можно указывать с точностью до секунд или миллисекунд.
Время передаётся в часовом поясе Мск (UTC+3).
Примеры:

  • 2019-06-20
  • 2019-06-20T23:59:59
  • 2019-06-20T00:00:00.12345
  • 2017-03-25T00:00:00

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Склад{{ /api/v1/supplier/stocks }}

Описание метода

Возвращает остатки товаров на складах WB. Данные обновляются раз в 30 минут. Сервис статистики не хранит историю остатков товаров, поэтому получить данные о них можно только на текущий момент

Максимум 1 запрос в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Дата и время последнего изменения по товару.
Для получения полного остатка следует указывать максимально раннее значение.
Например, 2019-06-20
Дата в формате RFC3339. Можно передать дату или дату со временем. Время можно указывать с точностью до секунд или миллисекунд.
Время передаётся в часовом поясе Мск (UTC+3).
Примеры:

  • 2019-06-20
  • 2019-06-20T23:59:59
  • 2019-06-20T00:00:00.12345
  • 2017-03-25T00:00:00

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Заказы{{ /api/v1/supplier/orders }}

Описание метода

Возвращает заказы. Данные обновляются раз в 30 минут. 1 строка = 1 заказ = 1 единица товара. Для определения заказа рекомендуем использовать поле srid. Данные заказа хранятся 90 дней от даты заказа

Максимум 1 запрос в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Дата и время последнего изменения по заказу.
Дата в формате RFC3339. Можно передать дату или дату со временем. Время можно указывать с точностью до секунд или миллисекунд.
Время передаётся в часовом поясе Мск (UTC+3).
Примеры:

  • 2019-06-20
  • 2019-06-20T23:59:59
  • 2019-06-20T00:00:00.12345
  • 2017-03-25T00:00:00

flag
integer
Default: 0

Если параметр flag=0 (или не указан в строке запроса), при вызове API возвращаются данные, у которых значение поля lastChangeDate (дата время обновления информации в сервисе) больше или равно переданному значению параметра dateFrom. При этом количество возвращенных строк данных варьируется в интервале от 0 до примерно 100 000.
Если параметр flag=1, то будет выгружена информация обо всех заказах или продажах с датой, равной переданному параметру dateFrom (в данном случае время в дате значения не имеет). При этом количество возвращенных строк данных будет равно количеству всех заказов или продаж, сделанных в указанную дату, переданную в параметре dateFrom.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Продажи{{ /api/v1/supplier/sales }}

Описание метода

Возвращает продажи и возвраты. Данные обновляются раз в 30 минут. 1 строка = 1 заказ = 1 единица товара. Для определения заказа рекомендуем использовать поле srid. Данные заказа хранятся 90 дней от даты продажи

Максимум 1 запрос в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Дата и время последнего изменения по продаже/возврату.
Дата в формате RFC3339. Можно передать дату или дату со временем. Время можно указывать с точностью до секунд или миллисекунд.
Время передаётся в часовом поясе Мск (UTC+3).
Примеры:

  • 2019-06-20
  • 2019-06-20T23:59:59
  • 2019-06-20T00:00:00.12345
  • 2017-03-25T00:00:00

flag
integer
Default: 0

Если параметр flag=0 (или не указан в строке запроса), при вызове API возвращаются данные, у которых значение поля lastChangeDate (дата время обновления информации в сервисе) больше или равно переданному значению параметра dateFrom. При этом количество возвращенных строк данных варьируется в интервале от 0 до примерно 100 000.
Если параметр flag=1, то будет выгружена информация обо всех заказах или продажах с датой, равной переданному параметру dateFrom (в данном случае время в дате значения не имеет). При этом количество возвращенных строк данных будет равно количеству всех заказов или продаж, сделанных в указанную дату, переданную в параметре dateFrom.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Отчёт по товарам с обязательной маркировкой{{ /api/v1/analytics/excise-report }}

Описание метода

Возвращает операции по маркируемым товарам

Максимум 10 запросов за 5 часов на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string

Начало отчётного периода в формате RFC3339. Можно передать дату или дату со временем. Примеры:

  • 2023-12-01
  • 2023-12-01T23:59:59
  • 2023-12-01T00:00:00.12345
  • 2023-12-01T00:00:00
dateTo
required
string

Конец отчётного периода в формате RFC3339. Можно передать дату или дату со временем. Примеры:

  • 2023-12-01
  • 2023-12-01T23:59:59
  • 2023-12-01T00:00:00.12345
  • 2023-12-01T00:00:00
Request Body schema: application/json
optional
countries
Array of strings
Items Enum: "AM" "BY" "KG" "KZ" "RU" "UZ"

Код стран по стандарту ISO 3166-2. Чтобы получить данные по всем странам, оставьте параметр пустым

Responses

Request samples

Content type
application/json
{
  • "countries": [
    ]
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Отчёт по остаткам на складах

Для доступа к методам используйте токен для категории Аналитика

Чтобы загрузить отчёт об остатках на складах WB:

  1. Создайте отчёт.
  2. Дождитесь, когда отчёт будет готов. Вы можете проверить статус готовности отчета. Готовый отчёт хранится 2 часа.
  3. Получите отчёт.

Создать отчёт{{ /api/v1/warehouse_remains }}

Описание метода

Создаёт задание на генерацию отчёта. Параметры groupBy и filter можно задать в любой комбинации — аналогично версии в личном кабинете.

Максимум 1 запрос в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
locale
string
Default: "ru"
Example: locale=ru

Язык полей ответа subjectName и warehouseName:

  • ru — русский
  • en — английский
  • zh — китайский. Значения warehouseName на английском
groupByBrand
boolean
Default: "false"
Example: groupByBrand=true

Разбивка по брендам

groupBySubject
boolean
Default: "false"
Example: groupBySubject=true

Разбивка по предметам

groupBySa
boolean
Default: "false"
Example: groupBySa=true

Разбивка по артикулам продавца

groupByNm
boolean
Default: "false"
Example: groupByNm=true

Разбивка по артикулам WB. Если groupByNm=true, в ответе будет поле volume

groupByBarcode
boolean
Default: "false"
Example: groupByBarcode=true

Разбивка по баркодам

groupBySize
boolean
Default: "false"
Example: groupBySize=true

Разбивка по размерам

filterPics
integer
Default: "0"
Example: filterPics=1

Фильтр по фото:

  • -1 — без фото
  • 0 — не применять фильтр
  • 1 — с фото
filterVolume
integer
Default: "0"
Example: filterVolume=3

Фильтр по объёму:

  • -1 — без габаритов
  • 0 — не применять фильтр
  • 3 — свыше трёх литров

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Проверить статус{{ /api/v1/warehouse_remains/tasks/{task_id}/status }}

Описание метода

Возвращает статус задания на генерацию

Максимум 1 запрос в 5 секунд на один аккаунт продавца
Authorizations:
HeaderApiKey
path Parameters
task_id
required
string
Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2

ID задания на генерацию

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Получить отчёт{{ /api/v1/warehouse_remains/tasks/{task_id}/download }}

Описание метода

Возвращает отчёт по ID задания

Максимум 1 запрос в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
path Parameters
task_id
required
string
Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2

ID задания на генерацию

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Отчёты по удержаниям

Для доступа к методам используйте токен для категории Аналитика

Самовыкупы{{ /api/v1/analytics/antifraud-details }}

Описание метода

Возвращает отчёт по удержаниям за самовыкупы. Отчёт формируется каждую неделю по средам, до 7:00 по московскому времени, и содержит данные за одну неделю. Можно получить отчёт за всё время с августа 2023.

Удержание за самовыкуп — 30% от стоимости товаров. Минимальная сумма всех удержаний — 100 000 ₽, если за неделю в ПВЗ привезли больше ваших товаров, чем на 100 000 ₽

Максимум 10 запросов за 100 минут на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
date
string
Example: date=2023-12-01

Дата, которая входит в отчётный период, ГГГГ-ММ-ДД.

Чтобы получить данные за всё время с августа 2023, не указывайте этот параметр

Responses

Response samples

Content type
application/json
{
  • "details": [
    ]
}

Подмена товара{{ /api/v1/analytics/incorrect-attachments }}

Описание метода

Возвращает отчёт об удержаниях за отправку не тех товаров, пустых коробок или коробок без товара, но с посторонними предметами. В таких случаях удерживается 100% от стоимости заказа.

Можно получить отчёт максимум за 31 день. Доступны данные с июня 2023

Максимум 1 запрос в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string
Example: dateFrom=2023-12-01

Начало отчётного периода, ГГГГ-ММ-ДД

dateTo
required
string
Example: dateTo=2023-12-15

Конец отчётного периода, ГГГГ-ММ-ДД

Responses

Response samples

Content type
application/json
{}

Коэффициент логистики и хранения{{ /api/v1/analytics/storage-coefficient }}

Описание метода

Возвращает коэффициенты логистики и хранения. Они рассчитываются на неделю, с понедельника по воскресенье.

В начале каждой недели для продавца рассчитывается новый коэффициент логистики и хранения. Затем стоимость логистики и хранения умножается на коэффициент этой недели.

Коэффициент считается на основе расхождения фактических и заявленных габаритов упаковки товара:

  1. Измеряем товары.
    Работники склада измеряют по одному товару каждого наименования с учётом упаковки (кроме товаров меньше 2 литров). Для расчёта используются измерения за 30 дней до начала текущей недели.

  2. Считаем коэффициент для товара.
    Результаты измерений сравниваются с габаритами из карточки товара. В зависимости от разницы каждому наименованию присваивается коэффициент по товару.

  3. Считаем коэффициент логистики и хранения.
    Коэффициент логистики и хранения — это средний коэффициент по товарам.

Коэффициент логистики и хранения равен 1, если:

  • По товарам продавца сделано меньше 10 уникальных измерений
  • Средняя разница в габаритах не больше 10%

Для продавцов с коэффициентом 1 стоимость логистики и хранения не увеличивается.

Можно получить данные с 31 октября 2022

Максимум 1 запрос в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
date
string
Example: date=2023-12-01

Дата, которая входит в отчётный период, ГГГГ-ММ-ДД

Responses

Response samples

Content type
application/json
{}

Маркировка товара{{ /api/v1/analytics/goods-labeling }}

Описание метода

Возвращает отчёт о штрафах за отсутствие обязательной маркировки товаров. В отчёте представлены фотографии товаров, на которых маркировка отсутствует либо не считывается. Можно получить данные максимум за 31 день, доступны данные с марта 2024

Максимум 10 запросов за 10 минут на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <date>
Example: dateFrom=2024-04-01

Начало отчётного периода, ГГГГ-ММ-ДД

dateTo
required
string <date>
Example: dateTo=2024-04-30

Конец отчётного периода, ГГГГ-ММ-ДД

Responses

Response samples

Content type
application/json

Смена характеристик{{ /api/v1/analytics/characteristics-change }}

Описание метода

Возвращает отчёт об удержаниях за смену характеристик товара. Если товары после приёмки не соответствуют заявленным цветам и размерам, и на складе их перемаркировали с правильными характеристиками, по таким товарам назначается штраф. Можно получить отчёт максимум за 31 день, доступны данные с 28 декабря 2021

Максимум 10 запросов за 10 минут на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <date>
Example: dateFrom=2024-04-01

Начало отчётного периода, ГГГГ-ММ-ДД

dateTo
required
string <date>
Example: dateTo=2024-04-30

Конец отчётного периода, ГГГГ-ММ-ДД

Responses

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Платная приёмка

Для доступа к методам используйте токен для категории Аналитика

Получить отчёт{{ /api/v1/analytics/acceptance-report }}

Описание метода

Возвращает даты и стоимость приёмки. Можно получить отчёт максимум за 31 день

Максимум 1 запрос в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string
Example: dateFrom=2023-12-01

Начало отчётного периода, ГГГГ-ММ-ДД

dateTo
required
string
Example: dateTo=2023-12-15

Конец отчётного периода, ГГГГ-ММ-ДД

Responses

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Платное хранение

Для доступа к методам используйте токен для категории Аналитика

Чтобы получить отчёт:

  1. Сгенерируйте отчёт
  2. Дождитесь, когда отчёт будет готов. Вы можете проверить статус готовности отчёта. Готовый отчёт хранится 2 часа, после чего его нельзя будет получить.
  3. Получите отчёт

Создать отчёт{{ /api/v1/paid_storage }}

Описание метода

Создаёт задание на генерацию отчёта. Можно получить отчёт максимум за 8 дней

Максимум 1 запрос в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string
Example: dateFrom=2022-01-01

Начало отчётного периода в формате RFC3339. Можно передать дату или дату со временем. Примеры:

  • 2019-06-20
  • 2019-06-20T23:59:59
  • 2019-06-20T00:00:00.12345
  • 2017-03-25T00:00:00
dateTo
required
string
Example: dateTo=2022-01-09

Конец отчётного периода в формате RFC3339. Можно передать дату или дату со временем. Примеры:

  • 2019-06-20
  • 2019-06-20T23:59:59
  • 2019-06-20T00:00:00.12345
  • 2017-03-25T00:00:00

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Проверить статус{{ /api/v1/paid_storage/tasks/{task_id}/status }}

Описание метода

Возвращает статус задания на генерацию отчёта

Максимум 1 запрос в 5 секунд на один аккаунт продавца
Authorizations:
HeaderApiKey
path Parameters
task_id
required
string
Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2

ID задания на генерацию

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Получить отчёт{{ /api/v1/paid_storage/tasks/{task_id}/download }}

Описание метода

Возвращает отчёт по ID задания

Максимум 1 запрос в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
path Parameters
task_id
required
string
Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2

ID задания на генерацию

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Продажи по регионам

Для доступа к методам используйте токен для категории Аналитика

Получить отчёт{{ /api/v1/analytics/region-sale }}

Описание метода

Возвращает данные продаж, сгруппированные по регионам стран. Можно получить отчёт максимум за 31 день.

Максимум 1 запрос в 10 секунд на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string
Example: dateFrom=2023-12-01

Начало отчётного периода, ГГГГ-ММ-ДД

dateTo
required
string
Example: dateTo=2023-12-15

Конец отчётного периода, ГГГГ-ММ-ДД

Responses

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Доля бренда в продажах

Для доступа к методам используйте токен для категории Аналитика

Отчёты по доле бренда продавца в продажах.

Для получения отчёта вам понадобятся:

  1. Названия брендов.
  2. ID и названия категорий.

Можно получить отчёт максимум за год

Бренды продавца{{ /api/v1/analytics/brand-share/brands }}

Описание метода

Возвращает список брендов продавца.

Можно получить только бренды, которые:

  • продавались за последние 90 дней
  • есть на складе WB
Максимум 1 запрос в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Родительские категории бренда{{ /api/v1/analytics/brand-share/parent-subjects }}

Описание метода

Возвращает родительские категории бренда.

Можно получить данные с 1 ноября 2022 года, максимум за 365 дней.

Максимум 1 запрос 5 секунд на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
locale
string
Default: "ru"
Example: locale=ru

Язык поля ответа parentName:

  • ru — русский
  • en — английский
  • zh — китайский
brand
required
string
Example: brand=H%26M

Бренд

dateFrom
required
string
Example: dateFrom=2023-12-01

Начало отчётного периода, ГГГГ-ММ-ДД

dateTo
required
string
Example: dateTo=2023-12-15

Конец отчётного периода, ГГГГ-ММ-ДД

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Получить отчёт{{ /api/v1/analytics/brand-share }}

Описание метода

Возвращает отчёт по доле бренда в продажах.

Можно получить данные с 1 ноября 2022 года, максимум за 365 дней.

Максимум 1 запрос 5 секунд на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
parentId
required
integer
Example: parentId=1

ID родительской категории

brand
required
string
Example: brand=H%26M

Бренд

dateFrom
required
string
Example: dateFrom=2023-12-01

Начало отчётного периода, ГГГГ-ММ-ДД

dateTo
required
string
Example: dateTo=2023-12-15

Конец отчётного периода, ГГГГ-ММ-ДД

Responses

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Скрытые товары

Для доступа к методам используйте токен для категории Аналитика

Заблокированные карточки{{ /api/v1/analytics/banned-products/blocked }}

Описание метода

Возвращает список заблокированных карточек

Максимум 1 запрос 10 секунд на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
sort
required
string
Enum: "brand" "nmId" "title" "vendorCode" "reason"
Example: sort=nmId

Сортировка

  • brand — по бренду
  • nmId — по артикулу WB
  • title — по наименованию товара
  • vendorCode — по артикулу продавца
  • reason — по причине блокировки
order
required
string
Enum: "desc" "asc"
Example: order=asc

Порядок выдачи

  • desc — от наибольшего числового значения к наименьшему, от последнего по алфавиту значения к первому
  • asc — от наименьшего числового значения к наибольшему, от первого по алфавиту значения к последнему

Responses

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Скрытые из каталога{{ /api/v1/analytics/banned-products/shadowed }}

Описание метода

Возвращает список товаров, скрытых из каталога

Максимум 1 запрос 10 секунд на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
sort
required
string
Enum: "brand" "nmId" "title" "vendorCode" "nmRating"
Example: sort=title

Сортировка

  • brand — по бренду
  • nmId — по артикулу WB
  • title — по наименованию товара
  • vendorCode — по артикулу продавца
  • nmRating — по рейтингу товара
order
required
string
Enum: "desc" "asc"
Example: order=desc

Порядок выдачи

  • desc — от наибольшего числового значения к наименьшему, от последнего по алфавиту значения к первому
  • asc — от наименьшего числового значения к наибольшему, от первого по алфавиту значения к последнему

Responses

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Отчёт по возвратам товаров

Для доступа к методам используйте токен для категории Аналитика

Получить отчёт{{ /api/v1/analytics/goods-return }}

Описание метода

Возвращает перечень возвратов товаров продавцу. Одним запросом можно получить отчёт максимум за 31 день.

Максимум 1 запрос минуту на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <date>
Example: dateFrom=2024-08-13

Дата начала отчётного периода

dateTo
required
string <date>
Example: dateTo=2024-08-27

Дата окончания отчётного периода

Responses

Response samples

Content type
application/json
{
  • "report": [
    ]
}