Поиск
API docs by Redocly

Аналитика и данные (analytics)

Узнать больше об аналитике и данных можно в справочном центре

В разделе описаны методы получения:

  1. Воронки продаж

  2. Ленты заказов

  3. Поисковых запросов по вашим товарам

  4. Истории остатков

  5. Аналитики продавца в формате CSV

Аналитика и данные

Узнать больше об аналитике и данных можно в справочном центре

В разделе описаны методы получения:

  1. Воронки продаж

  2. Ленты заказов

  3. Поисковых запросов по вашим товарам

  4. Истории остатков

  5. Аналитики продавца в формате CSV

Воронка продаж

Для доступа к методам используйте токен для категории Аналитика
Узнать больше об аналитике воронки продаж можно в справочном центре

Методы получения статистики:

  1. Карточек товаров за период
  2. Карточек товаров по дням
  3. Групп карточек товаров по дням
Таймзоны представлены в формате IANA, актуальный список можно посмотреть здесь

Статистика карточек товаров за период{{ /api/analytics/v3/sales-funnel/products }}

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

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

Данные отчёта обновляются 1 раз в 2 часа.

В течение часа после события появляется большая часть данных:

  • о заказах
  • о переходах в карточку товара
  • о добавлениях товаров в корзину

Малая часть этих данных может появляться в течение нескольких дней.

Выкупы, отмены и возвраты отображаются в отчёте за тот день, когда товар был заказан. Например, если заказ был сделан 1 января, а покупатель вернул товар 10 января, данные об этом возврате появятся в отчёте за 1 января.
Окончательные итоги продаж вы можете отслеживать с помощью детализаций к отчётам реализации.

Параметры brandNames,subjectIds, tagIds, nmIds могут быть пустыми [], тогда в ответе возвращаются все карточки продавца.

Если вы указали несколько параметров, в ответе будут карточки, в которых есть одновременно все эти параметры. Если карточки не подходят по параметрам запроса, вернётся пустой ответ [].

Можно получить отчёт максимум за последние 365 дней.

В данных предыдущего периода:

  • Данные в pastPeriod указаны за такой же период, что и в selectedPeriod
  • Если дата начала pastPeriod раньше, чем год назад от текущей даты, она будет приведена к виду: pastPeriod.start = текущая дата — 365 дней

Можно использовать пагинацию.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 3 запроса 20 сек 3 запроса
Сервисный 1 мин 3 запроса 20 сек 3 запроса
Базовый с секретом 1 мин 3 запроса 20 сек 3 запроса
Базовый 1 ч 2 запроса 30 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object

Запрашиваемый период

object

Период для сравнения

nmIds
Array of integers <uint64> [ 0 .. 1000 ] items [ items <uint64 > ]

Артикулы WB, по которым нужно составить отчёт. Оставьте пустым, чтобы получить отчёт обо всех товарах

brandNames
Array of strings

Список брендов для фильтрации

subjectIds
Array of integers <uint64> [ items <uint64 > ]

Список ID предметов для фильтрации

tagIds
Array of integers <uint64> [ items <uint64 > ]

Список ID ярлыков для фильтрации

skipDeletedNm
boolean

Скрыть удалённые товары

object

Параметры сортировки

limit
integer <uint32> <= 1000
Default: 50

Количество карточек товара в ответе

offset
integer <uint32>
Default: 0

Сколько элементов пропустить. Например, для значения 10 ответ начнётся с 11 элемента

Responses

Request samples

Content type
application/json
{
  • "selectedPeriod": {
    },
  • "pastPeriod": {
    },
  • "nmIds": [
    ],
  • "brandNames": [
    ],
  • "subjectIds": [
    ],
  • "tagIds": [
    ],
  • "skipDeletedNm": false,
  • "orderBy": {
    },
  • "limit": 231,
  • "offset": 10
}

Response samples

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

Статистика карточек товаров по дням{{ /api/analytics/v3/sales-funnel/products/history }}

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

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

Данные отчёта обновляются 1 раз в 2 часа.

В течение часа после события появляется большая часть данных:

  • о заказах
  • о переходах в карточку товара
  • о добавлениях товаров в корзину

Малая часть этих данных может появляться в течение нескольких дней.

Выкупы, отмены и возвраты отображаются в отчёте за тот день, когда товар был заказан. Например, если заказ был сделан 1 января, а покупатель вернул товар 10 января, данные об этом возврате появятся в отчёте за 1 января.
Окончательные итоги продаж вы можете отслеживать с помощью детализаций к отчётам реализации.

Чтобы получать отчёты за период до года, используйте методы Аналитика продавца CSV — тип DETAIL_HISTORY_REPORT. Отчёты этого типа доступны только с подпиской Джем
Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 3 запроса 20 сек 3 запроса
Сервисный 1 мин 3 запроса 20 сек 3 запроса
Базовый с секретом 1 мин 3 запроса 20 сек 3 запроса
Базовый 1 ч 2 запроса 30 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object

Запрашиваемый период

nmIds
required
Array of integers <uint64> [ 1 .. 20 ] items [ items <uint64 > ]

Артикулы WB, по которым нужно составить отчёт

skipDeletedNm
boolean

Скрыть удалённые товары

aggregationLevel
string
Default: day
Enum: day week

Тип агрегации. Если не указано, то по умолчанию используется агрегация по дням.
Доступные уровни агрегации day, week

Responses

Request samples

Content type
application/json
{
  • "selectedPeriod": {
    },
  • "nmIds": [
    ],
  • "skipDeletedNm": true,
  • "aggregationLevel": "day"
}

Response samples

Content type
application/json
[
  • {
    }
]

Статистика групп карточек товаров по дням{{ /api/analytics/v3/sales-funnel/grouped/history }}

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

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

Данные отчёта обновляются 1 раз в 2 часа.

В течение часа после события появляется большая часть данных:

  • о заказах
  • о переходах в карточку товара
  • о добавлениях товаров в корзину

Малая часть этих данных может появляться в течение нескольких дней.

Выкупы, отмены и возвраты отображаются в отчёте за тот день, когда товар был заказан. Например, если заказ был сделан 1 января, а покупатель вернул товар 10 января, данные об этом возврате появятся в отчёте за 1 января.
Окончательные итоги продаж вы можете отслеживать с помощью детализаций к отчётам реализации.

Параметры brandNames, subjectIds, tagIds могут быть пустыми [], тогда группировка происходит по всем карточкам продавца.

Произведение количества предметов, брендов, ярлыков в запросе может быть не больше 16. Например, 4 бренда и 4 предмета или 2 предмета, 2 ярлыка и 4 бренда.

Чтобы получать отчёты за период до года, используйте методы Аналитика продавца CSV — тип GROUPED_HISTORY_REPORT. Отчёты этого типа доступны только с подпиской Джем
Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 3 запроса 20 сек 3 запроса
Сервисный 1 мин 3 запроса 20 сек 3 запроса
Базовый с секретом 1 мин 3 запроса 20 сек 3 запроса
Базовый 1 ч 2 запроса 30 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object

Запрашиваемый период

brandNames
Array of strings

Список брендов для фильтрации

subjectIds
Array of integers <uint64> [ items <uint64 > ]

Список ID предметов для фильтрации

tagIds
Array of integers <uint64> [ items <uint64 > ]

Список ID ярлыков для фильтрации

skipDeletedNm
boolean

Скрыть удалённые товары

aggregationLevel
string
Default: day
Enum: day week

Тип агрегации. Если не указано, то по умолчанию используется агрегация по дням.
Доступные уровни агрегации day, week

Responses

Request samples

Content type
application/json
{
  • "selectedPeriod": {
    },
  • "brandNames": [
    ],
  • "subjectIds": [
    ],
  • "tagIds": [
    ],
  • "skipDeletedNm": false,
  • "aggregationLevel": "day"
}

Response samples

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

Лента заказов

Для доступа к методу используйте токен для категории Аналитика
Узнать больше о Ленте заказов можно в справочном центре

Метод получения отчёта Лента заказов

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

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

Метод формирует набор данных о заказах и продажах.

Данные отчёта обновляются в режиме реального времени.

1 заказ = 1 сборочное задание = 1 единица товара

Параметры brandNames,subjectIds, tagIds, nmIds могут быть пустыми [], тогда в ответе возвращаются все заказы продавца.
Если вы указали несколько параметров, в ответе будут заказы, в которых есть одновременно все эти параметры. Если заказы не подходят по параметрам запроса, вернётся пустой массив [].

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

Заказы отдаются по времени текущего статуса, от самого нового к самому раннему.

Можно использовать пагинацию.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 1 запрос 1 мин 1 запрос
Сервисный 1 мин 1 запрос 1 мин 1 запрос
Базовый с секретом 1 мин 1 запрос 1 мин 1 запрос
Базовый 3 ч 1 запрос 3 ч 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
object

Запрашиваемый период. По дате текущего статуса заказа

nmIds
Array of integers <uint64> <= 1000 items [ items <uint64 > ]

Список артикулов WB для фильтрации

subjectIds
Array of integers <uint64> <= 50 items [ items <uint64 > ]

Список ID предметов для фильтрации

brandNames
Array of strings <= 50 items

Список брендов для фильтрации

tagIds
Array of integers <uint64> <= 50 items [ items <uint64 > ]

Список ID ярлыков для фильтрации

object

Пагинация

Responses

Request samples

Content type
application/json
{
  • "selectedPeriod": {
    },
  • "nmIds": [
    ],
  • "subjectIds": [
    ],
  • "brandNames": [
    ],
  • "tagIds": [
    ],
  • "pagination": {
    }
}

Response samples

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

Поисковые запросы по вашим товарам

Для доступа к методам используйте токен для категории Аналитика
Узнать больше об аналитике поисковых запросов можно в справочном центре

Методы получения отчёта по поисковым запросам по вашим товарам, в частности:

  1. Основной страницы
  2. Дополнительных данных к основной странице с пагинацией по группам или пагинацией по товарам в группе
  3. Поисковых запросов по товару
  4. Заказов и позиций по поисковым запросам товара
Вы можете использовать эти методы только с подпиской Джем

Основная страница{{ /api/v2/search-report/report }}

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

Метод формирует набор данных для основной страницы отчёта по поисковым запросам с:

  • общей информацией
  • позициями товаров
  • данными по видимости и переходам в карточку
  • данными для таблицы по группам

Для получения дополнительных данных в таблице используйте отдельный запрос для:

Дополнительный параметр выбора списка товаров в таблице:

  • positionCluster — средняя позиция в поиске

Параметры includeSubstitutedSKUs и includeSearchTexts не могут одновременно иметь значение false.

Данные отчёта обновляются 1 раз в 2 часа.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 3 запроса 20 сек 3 запроса
Сервисный 1 мин 3 запроса 20 сек 3 запроса
Базовый с секретом 1 мин 3 запроса 20 сек 3 запроса
Базовый 1 ч 1 запрос 1 ч 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object

Текущий период

object

Прошлый период для сравнения. Количество дней — меньше или равно currentPeriod

nmIds
Array of integers <int32> [ items <int32 > ]

Список артикулов WB для фильтрации

subjectIds
Array of integers <int32> [ items <int32 > ]

Список ID предметов для фильтрации

brandNames
Array of strings

Список брендов для фильтрации

tagIds
Array of integers <int64> [ items <int64 > ]

Список ID ярлыков для фильтрации

positionCluster
required
string
Enum: all firstHundred secondHundred below

Товары с какой средней позицией в поиске показывать в отчёте:

  • all — все
  • firstHundred — от 1 до 100
  • secondHundred — от 101 до 200
  • below — от 201 и ниже
required
object

Параметры сортировки

includeSubstitutedSKUs
boolean
Default: true

Показать данные по прямым запросам с подменным артикулом

includeSearchTexts
boolean
Default: true

Показать данные по поисковым запросам без учёта подменного артикула

limit
required
integer <uint32> <= 1000

Количество групп товаров в ответе

offset
required
integer <uint32>

После какого элемента выдавать данные

Responses

Request samples

Content type
application/json
{
  • "currentPeriod": {
    },
  • "pastPeriod": {
    },
  • "nmIds": [
    ],
  • "subjectIds": [
    ],
  • "brandNames": [
    ],
  • "tagIds": [
    ],
  • "positionCluster": "all",
  • "orderBy": {
    },
  • "includeSubstitutedSKUs": true,
  • "includeSearchTexts": false,
  • "limit": 130,
  • "offset": 50
}

Response samples

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

Пагинация по группам{{ /api/v2/search-report/table/groups }}

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

Метод формирует дополнительные данные к основному отчёту с пагинацией по группам. Пагинация возможна только при наличии фильтра по бренду, предмету или ярлыку.

Дополнительный параметр выбора списка товаров в таблице:

  • positionCluster — средняя позиция в поиске

Параметры includeSubstitutedSKUs и includeSearchTexts не могут одновременно иметь значение false.

Данные отчёта обновляются 1 раз в 2 часа.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 3 запроса 20 сек 3 запроса
Сервисный 1 мин 3 запроса 20 сек 3 запроса
Базовый с секретом 1 мин 3 запроса 20 сек 3 запроса
Базовый 1 ч 1 запрос 1 ч 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object

Текущий период

object

Прошлый период для сравнения. Количество дней — меньше или равно currentPeriod

nmIds
Array of integers <int32> [ items <int32 > ]

Список артикулов WB для фильтрации

subjectIds
Array of integers <int32> [ items <int32 > ]

Список ID предметов для фильтрации

brandNames
Array of strings

Список брендов для фильтрации

tagIds
Array of integers <int64> [ items <int64 > ]

Список ID ярлыков для фильтрации

required
object

Параметры сортировки

positionCluster
required
string
Enum: all firstHundred secondHundred below

Товары с какой средней позицией в поиске показывать в отчёте:

  • all — все
  • firstHundred — от 1 до 100
  • secondHundred — от 101 до 200
  • below — от 201 и ниже
includeSubstitutedSKUs
boolean
Default: true

Показать данные по прямым запросам с подменным артикулом

includeSearchTexts
boolean
Default: true

Показать данные по поисковым запросам без учёта подменного артикула

limit
required
integer <uint32> <= 1000

Количество групп товаров в ответе

offset
required
integer <uint32>

После какого элемента выдавать данные

Responses

Request samples

Content type
application/json
{
  • "currentPeriod": {
    },
  • "pastPeriod": {
    },
  • "nmIds": [
    ],
  • "subjectIds": [
    ],
  • "brandNames": [
    ],
  • "tagIds": [
    ],
  • "orderBy": {
    },
  • "positionCluster": "all",
  • "includeSubstitutedSKUs": true,
  • "includeSearchTexts": false,
  • "limit": 130,
  • "offset": 50
}

Response samples

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

Пагинация по товарам в группе{{ /api/v2/search-report/table/details }}

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

Метод формирует дополнительные данные к основному отчёту с пагинацией по товарам в группе. Пагинация возможна вне зависимости от наличия фильтров.

Фильтры для пагинации по товарам в группе или без фильтров:

  • кортеж subjectId,brandName,tagId — фильтр для группы
  • nmIds — фильтр по карточке товара

Дополнительный параметр выбора списка товаров:

  • positionCluster — средняя позиция в поиске

Параметры includeSubstitutedSKUs и includeSearchTexts не могут одновременно иметь значение false.

Данные отчёта обновляются 1 раз в 2 часа.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 3 запроса 20 сек 3 запроса
Сервисный 1 мин 3 запроса 20 сек 3 запроса
Базовый с секретом 1 мин 3 запроса 20 сек 3 запроса
Базовый 1 ч 1 запрос 1 ч 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object

Текущий период

object

Прошлый период для сравнения. Количество дней — меньше или равно currentPeriod

subjectId
integer <int32>

ID предмета

brandName
string

Название товара

tagId
integer <int64>

ID ярлыка

nmIds
Array of integers <uint64> <= 50 items [ items <uint64 > ]

Список артикулов WB

required
object

Параметры сортировки

positionCluster
required
string
Enum: all firstHundred secondHundred below

Товары с какой средней позицией в поиске показывать в отчёте:

  • all — все
  • firstHundred — от 1 до 100
  • secondHundred — от 101 до 200
  • below — от 201 и ниже
includeSubstitutedSKUs
boolean
Default: true

Показать данные по прямым запросам с подменным артикулом

includeSearchTexts
boolean
Default: true

Показать данные по поисковым запросам без учёта подменного артикула

limit
required
integer <uint32> <= 1000

Количество товаров в ответе

offset
required
integer <uint32>

После какого элемента выдавать данные

Responses

Request samples

Content type
application/json
{
  • "currentPeriod": {
    },
  • "pastPeriod": {
    },
  • "subjectId": 123,
  • "brandName": "Apple",
  • "tagId": 45,
  • "nmIds": [
    ],
  • "orderBy": {
    },
  • "positionCluster": "all",
  • "includeSubstitutedSKUs": true,
  • "includeSearchTexts": false,
  • "limit": 150,
  • "offset": 100
}

Response samples

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

Поисковые запросы по товару{{ /api/v2/search-report/product/search-texts }}

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

Метод формирует топ поисковых запросов по товару.

Параметры выбора поисковых запросов:

  • limit — количество запросов, максимум 30. Для тарифов Джема Продвинутый и Премиальный максимум — 100.
  • topOrderBy — способ выбора топа запросов

Параметры includeSubstitutedSKUs и includeSearchTexts не могут одновременно иметь значение false.

Данные отчёта обновляются 1 раз в 2 часа.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 3 запроса 20 сек 3 запроса
Сервисный 1 мин 3 запроса 20 сек 3 запроса
Базовый с секретом 1 мин 3 запроса 20 сек 3 запроса
Базовый 1 ч 1 запрос 1 ч 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object

Текущий период

object

Прошлый период для сравнения. Количество дней — меньше или равно currentPeriod

nmIds
required
Array of integers <uint64> <= 50 items [ items <uint64 > ]

Список артикулов WB

topOrderBy
required
string
Enum: openCard addToCart openToCart orders cartToOrder

Фильтрация по поисковым запросам, по которым больше всего:

  • openCard — перешли в карточку
  • addToCart — добавили в корзину
  • openToCart — конверсия в корзину
  • orders — заказали товаров
  • cartToOrder — конверсия в заказ
includeSubstitutedSKUs
boolean
Default: true

Показать данные по прямым запросам с подменным артикулом

includeSearchTexts
boolean
Default: true

Показать данные по поисковым запросам без учёта подменного артикула

required
object

Параметры сортировки

required
StandardTariff (integer) or AdvancedTariff (integer)

Responses

Request samples

Content type
application/json
{
  • "currentPeriod": {
    },
  • "pastPeriod": {
    },
  • "nmIds": [
    ],
  • "topOrderBy": "openToCart",
  • "includeSubstitutedSKUs": true,
  • "includeSearchTexts": false,
  • "orderBy": {
    },
  • "limit": 20
}

Response samples

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

Заказы и позиции по поисковым запросам товара{{ /api/v2/search-report/product/orders }}

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

Метод формирует данные для таблицы:

  • о заказах по каждому поисковому запросу для конкретного товара
  • о позициях товара в результатах поиска по каждому запросу

Данные указаны в рамках периода для запрошенного товара и сгруппированы по дням. Максимальный период — 7 дней.

Данные отчёта обновляются 1 раз в 2 часа.

Можно получить отчёт максимум за последние 365 дней с момента выполнения запроса
Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 3 запроса 20 сек 3 запроса
Сервисный 1 мин 3 запроса 20 сек 3 запроса
Базовый с секретом 1 мин 3 запроса 20 сек 3 запроса
Базовый 1 ч 1 запрос 1 ч 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object

Текущий период. Максимум 7 суток

nmId
required
integer <uint64>

Артикул WB

searchTexts
required
Array of strings [ 1 .. 30 ] items

Поисковые запросы. Для тарифов Джема Продвинутый и Премиальный максимум — 100

Responses

Request samples

Content type
application/json
{
  • "period": {
    },
  • "nmId": 211131895,
  • "searchTexts": [
    ]
}

Response samples

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

История остатков

Для доступа к методам используйте токен для категории Аналитика
Узнать больше об аналитике остатков можно в справочном центре

Это информация из детализированной таблицы товаров и виджета детализации по регионам.

Остатки в ответах данных методов — на текущий день.

Чтобы получать остатки по дням за период до 3 месяцев от текущей даты, используйте методы Аналитика продавца CSV — тип отчёта STOCK_HISTORY_DAILY_CSV

Методы получения отчёта по статистике остатков:

  1. Текущих остатков на складах WB по размерам
  2. Данных по таблице товаров с агрегацией по группам, товарам, размерам
  3. Данных виджета Статистика по регионам отгрузки с детализацией по складам

Остатки на складах WB{{ /api/analytics/v1/stocks-report/wb-warehouses }}

Описание метода
Метод доступен по Персональному токену, Сервисному токену, Базовому токену с секретом

Метод возвращает текущие остатки товаров на складах WB.

Данные обновляются 1 раз в 30 минут.

1 строка ответа — данные об 1 размере товара на 1 складе WB.

Лимит запросов на один профиль продавца:
Период Лимит Интервал Всплеск
1 мин 3 запроса 20 сек 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmIds
Array of integers <int64> [ 0 .. 1000 ] items [ items <int64 > ]

Артикулы WB

chrtIds
Array of integers <uint64> [ items <uint64 > ]

ID размеров. Используется только для указанных в массиве nmIds артикулов

limit
integer <uint32> <= 250000
Default: 250000

Количество строк в ответе

offset
integer <uint32>
Default: 0

Сколько элементов пропустить. Например, для значения 10 ответ начнётся с 11 элемента

Responses

Request samples

Content type
application/json
{
  • "nmIds": [
    ],
  • "chrtIds": [
    ],
  • "limit": 250000,
  • "offset": 500000
}

Response samples

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

Остатки на складах продавца{{ /api/analytics/v1/stocks-report/seller-warehouses }}

Описание метода
Метод доступен по Персональному токену, Сервисному токену

Метод возвращает текущие остатки товаров на складах продавца.

Данные обновляются 1 раз в 30 минут.

1 строка ответа — данные об 1 размере товара на 1 складе продавца.

Лимит запросов на один профиль продавца:
Период Лимит Интервал Всплеск
1 мин 3 запроса 20 сек 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmIds
Array of integers <int64> [ 0 .. 1000 ] items [ items <int64 > ]

Артикулы WB

chrtIds
Array of integers <uint64> [ items <uint64 > ]

ID размеров. Используется только для указанных в массиве nmIds артикулов

limit
integer <uint32> <= 250000
Default: 250000

Количество строк в ответе

offset
integer <uint32>
Default: 0

Сколько элементов пропустить. Например, для значения 10 ответ начнётся с 11 элемента

Responses

Request samples

Content type
application/json
{
  • "nmIds": [
    ],
  • "chrtIds": [
    ],
  • "limit": 250000,
  • "offset": 500000
}

Response samples

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

Данные по группам{{ /api/v2/stocks-report/products/groups }}

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

Метод формирует набор данных об остатках по группам товаров.

Группа товаров описывается кортежем subjectID, brandName, tagID.

Данные отчёта обновляются 1 раз в 2 часа.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 3 запроса 20 сек 3 запроса
Сервисный 1 мин 3 запроса 20 сек 3 запроса
Базовый с секретом 1 мин 3 запроса 20 сек 3 запроса
Базовый 1 ч 2 запроса 30 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmIDs
Array of integers <int64> [ items <int64 > ]

Список артикулов WB для фильтрации

subjectIDs
Array of integers <int32> [ items <int32 > ]

Список ID предметов для фильтрации

brandNames
Array of strings

Список брендов для фильтрации

tagIDs
Array of integers <int64> [ items <int64 > ]

Список ID ярлыков для фильтрации

required
object

Период

stockType
required
string
Enum: wb mp

Тип складов хранения товаров:

  • "" — все
  • wb — склады WB
  • mp — склады продавца
skipDeletedNm
required
boolean

Скрыть удалённые товары

availabilityFilters
required
Array of strings
Items Enum: deficient actual balanced nonActual nonLiquid invalidData

Доступность товара:

  • deficient — Дефицит
  • actual — Актуальный
  • balanced — Баланс
  • nonActual — Неактуальный
  • nonLiquid — Неликвид
  • invalidData — Не рассчитано
required
object

Вид сортировки данных

limit
integer <uint32> <= 1000
Default: 100

Количество групп в ответе

offset
required
integer <uint32>

После какого элемента выдавать данные

Responses

Request samples

Content type
application/json
{
  • "nmIDs": [
    ],
  • "subjectIDs": [
    ],
  • "brandNames": [
    ],
  • "tagIDs": [
    ],
  • "currentPeriod": {
    },
  • "stockType": "mp",
  • "skipDeletedNm": true,
  • "availabilityFilters": [
    ],
  • "orderBy": {
    },
  • "limit": 150,
  • "offset": 100
}

Response samples

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

Данные по товарам{{ /api/v2/stocks-report/products/products }}

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

Метод формирует набор данных об остатках по товарам.

Можно получить данные как по отдельным товарам, так и в рамках всего отчёта — если в запросе отсутствуют фильтры: nmIDs, subjectID, brandName, tagID.

Данные отчёта обновляются 1 раз в 2 часа.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 3 запроса 20 сек 3 запроса
Сервисный 1 мин 3 запроса 20 сек 3 запроса
Базовый с секретом 1 мин 3 запроса 20 сек 3 запроса
Базовый 1 ч 2 запроса 30 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmIDs
Array of integers <int64> [ items <int64 > ]

Список артикулов WB для фильтрации

subjectID
integer <int32>

ID предмета

brandName
string

Бренд

tagID
integer <int64>

ID ярлыка

required
object

Период

stockType
required
string
Enum: wb mp

Тип складов хранения товаров:

  • "" — все
  • wb — склады WB
  • mp — склады продавца
skipDeletedNm
required
boolean

Скрыть удалённые товары

required
object

Вид сортировки данных

availabilityFilters
required
Array of strings
Items Enum: deficient actual balanced nonActual nonLiquid invalidData

Доступность товара:

  • deficient — Дефицит
  • actual — Актуальный
  • balanced — Баланс
  • nonActual — Неактуальный
  • nonLiquid — Неликвид
  • invalidData — Не рассчитано
limit
integer <uint32> <= 1000
Default: 100

Количество товаров в ответе

offset
required
integer <uint32>

После какого элемента выдавать данные

Responses

Request samples

Content type
application/json
{
  • "nmIDs": [
    ],
  • "subjectID": 123456,
  • "brandName": "Спортик",
  • "tagID": 25345,
  • "currentPeriod": {
    },
  • "stockType": "mp",
  • "skipDeletedNm": true,
  • "orderBy": {
    },
  • "availabilityFilters": [
    ],
  • "limit": 150,
  • "offset": 100
}

Response samples

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

Данные по размерам{{ /api/v2/stocks-report/products/sizes }}

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

Метод формирует набор данных об остатках по размерам товара.

Возможны случаи:

  1. Товар имеет размеры и "includeOffice":true, тогда в ответе будут данные об остатках по каждому из размеров с вложенной детализацией по складам.
  2. Товар имеет размеры и "includeOffice":false, тогда в ответе будут данные об остатках по каждому из размеров без вложенной детализации по складам.
  3. Товар не имеет размера и "includeOffice":true, тогда в ответе будет детализация по складам. Без данных об остатках по каждому из размеров.
  4. Товар не имеет размера и "includeOffice":false, тогда тело ответа будет пустым.

    Товар не имеет размера, если у него единственный размер с "techSize":"0". В ответах метода получения данных по товарам у таких товаров "hasSizes":false.

    Данные по складам продавца приходят в агрегированном виде — без детализации по конкретным складам — эти записи будут с "regionName":"Свой склад" или "regionName":"Свой склад СГТ" и "officeName":"".

Данные отчёта обновляются 1 раз в 2 часа.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 3 запроса 20 сек 3 запроса
Сервисный 1 мин 3 запроса 20 сек 3 запроса
Базовый с секретом 1 мин 3 запроса 20 сек 3 запроса
Базовый 1 ч 2 запроса 30 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmID
required
integer <int64>

Артикул WB

required
object

Период

stockType
required
string
Enum: wb mp

Тип складов хранения товаров:

  • "" — все
  • wb — склады WB
  • mp — склады продавца
required
object

Вид сортировки данных

includeOffice
required
boolean

Включить детализацию по складам

Responses

Request samples

Content type
application/json
{
  • "nmID": 123456789,
  • "currentPeriod": {
    },
  • "stockType": "mp",
  • "orderBy": {
    },
  • "includeOffice": true
}

Response samples

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

Данные по складам{{ /api/v2/stocks-report/offices }}

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

Метод формирует набор данных об остатках по складам.

Данные по складам продавца приходят в агрегированном виде — без детализации по конкретным складам — эти записи будут с "regionName":"Свой склад" или "regionName":"Свой склад СГТ" и "offices":[].

Данные отчёта обновляются 1 раз в 2 часа.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 3 запроса 20 сек 3 запроса
Сервисный 1 мин 3 запроса 20 сек 3 запроса
Базовый с секретом 1 мин 3 запроса 20 сек 3 запроса
Базовый 1 ч 2 запроса 30 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmIDs
Array of integers <int64> [ items <int64 > ]

Список артикулов WB для фильтрации

subjectIDs
Array of integers <int32> [ items <int32 > ]

Список ID предметов для фильтрации

brandNames
Array of strings

Список брендов для фильтрации

tagIDs
Array of integers <int64> [ items <int64 > ]

Список ID ярлыков для фильтрации

required
object

Период

stockType
required
string
Enum: wb mp

Тип складов хранения товаров:

  • "" — все
  • wb — склады WB
  • mp — склады продавца
skipDeletedNm
required
boolean

Скрыть удалённые товары

Responses

Request samples

Content type
application/json
{
  • "nmIDs": [
    ],
  • "subjectIDs": [
    ],
  • "brandNames": [
    ],
  • "tagIDs": [
    ],
  • "currentPeriod": {
    },
  • "stockType": "mp",
  • "skipDeletedNm": false
}

Response samples

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

Оценка товара

Для доступа к методу используйте токен для категории Аналитика
Узнать больше об аналитике оценок товаров можно в справочном центре

Метод получения отчёта Оценка товара

Получить отчёт{{ /api/analytics/v2/item-rating }}

Описание метода
Метод доступен по Персональному токену, Сервисному токену

Метод формирует набор данных об оценках товаров.

Данные отчёта обновляются 1 раз в час.

Лимит запросов на один профиль продавца:
Период Лимит Интервал Всплеск
1 мин 3 запроса 20 сек 3 запроса
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object

Текущий период

object

Прошлый период для сравнения. Количество дней — меньше или равно currentPeriod

nmIds
Array of integers <int32> <= 50 items [ items <int32 > ]

Список артикулов WB для фильтрации

subjectIds
Array of integers <int32> <= 50 items [ items <int32 > ]

Список ID предметов для фильтрации

brandNames
Array of strings <= 50 items

Список брендов для фильтрации

tagIds
Array of integers <int64> <= 50 items [ items <int64 > ]

Список ID ярлыков для фильтрации

isNotIncludeNmsWithoutSales
boolean
Default: false

Не возвращать товары без продаж:

  • true — да, возвращаются только товары с продажами за период, указанный в объекте currentPeriod
  • false — нет, возвращаются все товары, если не указаны другие параметры
onlyShadowedNms
boolean
Default: false

Возвращаются ли в ответе только скрытые товары:

  • true — да, возвращаются только скрытые из каталога товары
  • false — нет, возвращаются все товары, если не указаны другие параметры
required
object

Параметры сортировки

limit
integer <uint32> <= 1000
Default: 100

Количество товаров в ответе

offset
required
integer <uint32>

Сколько элементов пропустить. Например, для значения 10 ответ начнётся с 11 элемента

Responses

Request samples

Content type
application/json
{
  • "currentPeriod": {
    },
  • "pastPeriod": {
    },
  • "nmIds": [
    ],
  • "subjectIds": [
    ],
  • "brandNames": [
    ],
  • "tagIds": [
    ],
  • "isNotIncludeNmsWithoutSales": true,
  • "onlyShadowedNms": true,
  • "orderBy": {
    },
  • "limit": 130,
  • "offset": 50
}

Response samples

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

Аналитика продавца CSV

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

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

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

Можно получить отчёт максимум за год. Отчёты по остаткам — за 3 месяца.

Максимальное количество отчётов, генерируемых в сутки — 20.

Вы можете использовать эти методы — за исключением отчётов по остаткам — только с подпиской Джем

Создать отчёт{{ /api/v2/nm-report/downloads }}

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

Метод создаёт задание на генерацию отчёта с расширенной аналитикой продавца.

Вы можете создать CSV-версии отчётов по воронке продаж или параметрам поиска с группировкой по:

  • артикулам WB
  • предметам, брендам и ярлыкам

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

Также можете создать CSV-версии отчётов по текстам поисковых запросов и остаткам.

Каждый новый отчёт должен иметь уникальный ID.

Не используйте одинаковые ID для разных отчётов — это может привести к ошибкам при генерации

Набор параметров запроса в объекте params зависит от типа отчёта. Чтобы получить описание параметров, выберите тип отчёта в раскрывающемся списке в описании параметра reportType.

Параметры includeSubstitutedSKUs и includeSearchTexts не могут одновременно иметь значение false.

Если не удалось получить отчёт, можно создать повторное задание на генерацию. Также можно получить список и проверить статусы отчётов.

Данные отчётов обновляются 1 раз в 2 часа.

Отчёты по остаткам — типы STOCK_HISTORY_REPORT_CSV и STOCK_HISTORY_DAILY_CSV — можно создать без подписки Джем
Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 3 запроса 20 сек 3 запроса
Сервисный 1 мин 3 запроса 20 сек 3 запроса
Базовый с секретом 1 мин 3 запроса 20 сек 3 запроса
Базовый 1 ч 1 запрос 1 ч 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
id
required
string <uuid>

ID отчёта в UUID-формате. Генерируется продавцом самостоятельно

reportType
required
string

Тип отчёта DETAIL_HISTORY_REPORT — Воронка продаж. По артикулам WB

userReportName
string

Название отчёта. Если не указано, сформируется автоматически

required
object

Параметры отчёта

Responses

Request samples

Content type
application/json
Example

Воронка продаж. По артикулам WB

{
  • "id": "06eae887-9d9f-491f-b16a-bb1766fcb8d2",
  • "reportType": "DETAIL_HISTORY_REPORT",
  • "userReportName": "Listing report",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "data": "Началось формирование файла/отчета"
}

Получить список отчётов{{ /api/v2/nm-report/downloads }}

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

Метод возвращает список отчётов с расширенной аналитикой продавца. Ответ содержит ID созданных отчётов и статусы генерации.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 3 запроса 20 сек 3 запроса
Сервисный 1 мин 3 запроса 20 сек 3 запроса
Базовый с секретом 1 мин 3 запроса 20 сек 3 запроса
Базовый 1 ч 1 запрос 1 ч 1 запрос
Authorizations:
HeaderApiKey
query Parameters
filter[downloadIds]
Array of strings <uuid> [ items <uuid > ]

ID отчёта

Responses

Response samples

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

Сгенерировать отчёт повторно{{ /api/v2/nm-report/downloads/retry }}

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

Метод создает повторное задание на генерацию отчёта с расширенной аналитикой продавца. Необходимо, если при генерации отчёта вы получили статус FAILED.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 3 запроса 20 сек 3 запроса
Сервисный 1 мин 3 запроса 20 сек 3 запроса
Базовый с секретом 1 мин 3 запроса 20 сек 3 запроса
Базовый 1 ч 1 запрос 1 ч 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
downloadId
string <uuid>

ID отчёта

Responses

Request samples

Content type
application/json
{
  • "downloadId": "06eea887-9d9f-491f-b16a-bb1766fcb8d2"
}

Response samples

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

Получить отчёт{{ /api/v2/nm-report/downloads/file/{downloadId} }}

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

Метод возвращает отчёт с расширенной аналитикой продавца по ID задания на генерацию.

Можно получить отчёт, который сгенерирован за последние 48 часов.
Отчёт будет загружен внутри архива ZIP в формате CSV.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 3 запроса 20 сек 3 запроса
Сервисный 1 мин 3 запроса 20 сек 3 запроса
Базовый с секретом 1 мин 3 запроса 20 сек 3 запроса
Базовый 1 ч 1 запрос 1 ч 1 запрос
Authorizations:
HeaderApiKey
path Parameters
downloadId
required
string <uuid>

ID отчёта

Responses

Response samples

Content type
application/zip
Example
nmID, dt, openCardCount, addToCartCount, ordersCount, ordersSumRub, buyoutsCount, buyoutsSumRub, cancelCount, cancelSumRub, addToCartConversion, cartToOrderConversion, buyoutPercent, addToWishlist, currency
70027655,2024-11-21,1,0,0,0,0,0,0,0,0,0,0,0,RUB
...
...
150317666,2024-11-21,2,0,0,0,0,0,0,0,0,0,0,0,RUB