API docs by Redocly

Описание API Аналитика

Сервис предоставляет публичный API для получения аналитических данных. С помощью этих методов вы можете получать аналитические отчёты.

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

Таймзоны

Формат IANA, актуальный список можно посмотреть здесь.

Получение статистики КТ за выбранный период, по nmID/предметам/брендам/ярлыкам

Получение статистики КТ за выбранный период, по nmID/предметам/брендам/ярлыкам.
Поля brandNames,objectIDs, tagIDs, nmIDs могут быть пустыми, тогда в ответе идут все карточки продавца.
При выборе нескольких полей в ответ приходят данные по карточкам, у которых есть все выбранные поля. Работает с пагинацией.
Можно получить отчёт максимум за последний год (365 дней).
Также в данных, где предоставляется информация по предыдущему периоду:

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


Максимум 3 запроса в минуту.

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
brandNames
Array of strings

Название бренда

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

ID предмета

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

ID ярлыка

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

Артикул WB

timezone
string

Временная зона.
Если не указано, то по умолчанию используется Europe/Moscow.

required
object

Период

object

Параметры сортировки. Если не указано, то по умолчанию используется значение "openCard" и сортировка по убыванию.

Все виды сортировки field:
openCard — по открытию карточки (переход на страницу товара)
addToCart — по добавлениям в корзину
orders — по кол-ву заказов
avgRubPrice — по средней цене в рублях
ordersSumRub — по сумме заказов в рублях
stockMpQty — по кол-ву остатков маркетплейса шт.
stockWbQty — по кол-ву остатков на складе шт.
cancelSumRub — сумме возвратов в рублях
cancelCount — по кол-ву возвратов
buyoutCount — по кол-ву выкупов
buyoutSumRub — по сумме выкупов
page
required
integer <int32>

Страница

Responses

Response Schema: application/json
object
error
boolean

Флаг ошибки

errorText
string

Описание ошибки

Array of objects

Дополнительные ошибки

Request samples

Content type
application/json
{
  • "brandNames": [
    ],
  • "objectIDs": [
    ],
  • "tagIDs": [
    ],
  • "nmIDs": [
    ],
  • "timezone": "Europe/Moscow",
  • "period": {
    },
  • "orderBy": {
    },
  • "page": 1
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": true,
  • "errorText": "",
  • "additionalErrors": [
    ]
}

Получение статистики КТ за период, сгруппированный по предметам, брендам и ярлыкам

Получение статистики КТ за период, сгруппированный по предметам, брендам и ярлыкам.
Поля brandNames, objectIDs, tagIDs могут быть пустыми, тогда группировка происходит по всем карточкам продавца.
Можно получить отчёт максимум за последний год (365 дней).
Также в данных, где предоставляется информация по предыдущему периоду:

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


Максимум 3 запроса в минуту.

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
objectIDs
Array of integers <int32> [ items <int32 > ]

ID предмета

brandNames
Array of strings

Название бренда

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

ID ярлыка

timezone
string

Временная зона.
Если не указано, то по умолчанию используется Europe/Moscow.

required
object

Период

object

Параметры сортировки. Если не указано, то по умолчанию используется значение "openCard" и сортировка по убыванию.

Все виды сортировки field:
openCard — по открытию карточки (переход на страницу товара)
addToCart — по добавлениям в корзину
orders — по кол-ву заказов
avgRubPrice — по средней цене в рублях
ordersSumRub — по сумме заказов в рублях
stockMpQty — по кол-ву остатков маркетплейса шт.
stockWbQty — по кол-ву остатков на складе шт.
page
required
integer <int32>

Страница

Responses

Response Schema: application/json
object
error
boolean

Флаг ошибки

errorText
string

Описание ошибки

Array of objects

Дополнительные ошибки

Request samples

Content type
application/json
{
  • "objectIDs": [
    ],
  • "brandNames": [
    ],
  • "tagIDs": [
    ],
  • "timezone": "Europe/Moscow",
  • "period": {
    },
  • "orderBy": {
    },
  • "page": 1
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": true,
  • "errorText": "",
  • "additionalErrors": [
    ]
}

Получение статистики КТ по дням по выбранным nmID

Получение статистики КТ по дням по выбранным nmID. Можно получить отчёт максимум за последнюю неделю. Чтобы получать отчёты за период до года, подпишитесь на расширенную аналитику Джем.
Максимум 3 запроса в минуту.

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmIDs
required
Array of integers <int32> [ items <int32 > ]

Артикул WB (максимум 20)

required
object

Период

timezone
string

Временная зона.
Если не указано, то по умолчанию используется Europe/Moscow.

aggregationLevel
string

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

Responses

Response Schema: application/json
Array of objects
error
boolean

Флаг ошибки

errorText
string

Описание ошибки

Array of objects

Дополнительные ошибки

Request samples

Content type
application/json
{
  • "nmIDs": [
    ],
  • "period": {
    },
  • "timezone": "Europe/Moscow",
  • "aggregationLevel": "day"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": true,
  • "errorText": "",
  • "additionalErrors": [
    ]
}

Получение статистики КТ по дням за период, сгруппированный по предметам, брендам и ярлыкам

Получение статистики КТ по дням за период, сгруппированный по предметам, брендам и ярлыкам.
Поля brandNames, objectIDs, tagIDs могут быть пустыми, тогда группировка происходит по всем карточкам продавца.
В запросе произведение количества предметов, брендов, ярлыков не должно быть больше 16. Можно получить отчёт максимум за последнюю неделю. Чтобы получать отчёты за период до года, подпишитесь на расширенную аналитику Джем.
Максимум 3 запроса в минуту.

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
objectIDs
Array of integers <int32> [ items <int32 > ]

ID предмета

brandNames
Array of strings

Название бренда

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

ID ярлыка

required
object

Период

timezone
string

Временная зона.
Если не указано, то по умолчанию используется Europe/Moscow.

aggregationLevel
string

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

Responses

Response Schema: application/json
Array of objects
error
boolean

Флаг ошибки

errorText
string

Описание ошибки

Array of objects

Дополнительные ошибки

Request samples

Content type
application/json
{
  • "objectIDs": [
    ],
  • "brandNames": [
    ],
  • "tagIDs": [
    ],
  • "period": {
    },
  • "timezone": "Europe/Moscow",
  • "aggregationLevel": "day"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": true,
  • "errorText": "",
  • "additionalErrors": [
    ]
}

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

С помощью этих методов можно получать отчёт по поисковым запросам

Вы можете использовать эти методы только с подпиской Джем.

Основная страница

Формирует набор данных для основной страницы отчёта с:

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

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

  • пагинации по группам
  • получения по товарам в группе

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

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


Максимум 3 запроса в минуту.

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object (Period)

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

object (pastPeriod)

Прошлый период для сравнения. Количество дней — меньше или равно 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 (PositionCluster)
Enum: "all" "firstHundred" "secondHundred" "below"

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

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

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

limit
required
integer <uint32> <= 1000

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

offset
required
integer <uint32>

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

Responses

Response Schema: application/json
required
object

Request samples

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

Response samples

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

Пагинация по группам

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

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

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


Максимум 3 запроса в минуту.

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object (Period)

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

object (pastPeriod)

Прошлый период для сравнения. Количество дней — меньше или равно 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 (OrderBy)

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

positionCluster
required
string (PositionCluster)
Enum: "all" "firstHundred" "secondHundred" "below"

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

  • all — все
  • firstHundred — от 1 до 100
  • secondHundred — от 101 до 200
  • below — от 201 и ниже
limit
required
integer <uint32> <= 1000

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

offset
required
integer <uint32>

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

Responses

Response Schema: application/json
required
object

Request samples

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

Response samples

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

Пагинация по товарам в группе

Пагинация по товарам в группе. Возможна независимо от наличия фильтров.

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

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

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

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


Максимум 3 запроса в минуту.

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object (Period)

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

object (pastPeriod)

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

subjectId
integer <int32>

ID предмета

brandName
string

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

tagId
integer <int64>

ID ярлыка

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

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

required
object (OrderBy)

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

positionCluster
required
string
Enum: "all" "firstHundred" "secondHundred" "below"

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

  • all — все
  • firstHundred — от 1 до 100
  • secondHundred — от 101 до 200
  • below — от 201 и ниже
limit
required
integer <uint32> <= 1000

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

offset
required
integer <uint32>

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

Responses

Response Schema: application/json
required
object

Request samples

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

Response samples

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

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

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

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

  • limit — количество запросов (максимум 30)
  • topOrderBy — способ выбора топа запросов


Максимум 3 запроса в минуту.

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object (Period)

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

object (pastPeriod)

Прошлый период для сравнения. Количество дней — меньше или равно 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 — конверсия в заказ из поиска
required
object (OrderBy)

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

limit
required
integer <uint64> (TextLimit) [ 1 .. 30 ]

Количество поисковых запросов по товару

Responses

Response Schema: application/json
required
object

Request samples

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

Response samples

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

Заказы и позиции по поисковым запросам товара

Формирует данные для таблицы по количеству заказов и позиций по запросам. Данные указываются в рамках периода для определённого товара.

Максимум 3 запроса в минуту.

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object (PeriodOrdersRequest)

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

nmId
required
integer <uint64>

Артикул WB

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

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

Responses

Response Schema: application/json
required
object

Request samples

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

Response samples

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

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

Вы можете использовать эти методы только с подпиской Джем.

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

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

Создать отчёт

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

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

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


Максимум 3 запроса в минуту, при этом в сутки можно сгенерировать максимум 20 отчётов (считаются только успешные генерации).

Authorizations:
HeaderApiKey
Request Body schema: application/json
One of
id
required
string <uuid>

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

reportType
required
string

Тип отчёта — DETAIL_HISTORY_REPORT

userReportName
string

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

required
object

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

Responses

Response Schema: application/json
data
required
string

Уведомление, что началась генерация отчёта

Request samples

Content type
application/json
Example

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

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

Response samples

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

Получить список отчётов

Максимум 3 запроса в минуту
Authorizations:
HeaderApiKey
query Parameters
filter[downloadIds]
Array of strings <uuid> [ items <uuid > ]

ID отчёта

Responses

Response Schema: application/json
required
Array of objects

Response samples

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

Сгенерировать отчёт повторно

Максимум 3 запроса в минуту
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
downloadId
string <uuid>

ID отчёта

Responses

Response Schema: application/json
data
required
string

Уведомление, что началась повторная генерация отчёта

Request samples

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

Response samples

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

Получить отчёт

Получить отчёт с расширенной аналитикой.

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

Максимум 3 запроса в минуту
Authorizations:
HeaderApiKey
path Parameters
downloadId
required
string <uuid>

ID отчёта

Responses

Response Schema: text/csv
string <binary>

Описание полей в файле CSV:

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

Имя Тип Формат Описание
nmID (только для DETAIL_HISTORY_REPORT) integer int32 Артикул WB
dt string date Дата
openCardCount integer int32 Переходы в карточку товара
addToCartCount integer int32 Положили в корзину, шт.
ordersCount integer int32 Заказали товаров, шт.
ordersSumRub integer int32 Заказали на сумму, ₽
buyoutsCount integer int32 Выкупили товаров, шт.
buyoutsSumRub integer int32 Выкупили на сумму, ₽
cancelCount integer int32 Отменили товаров, шт.
cancelSumRub integer int32 Отменили на сумму, ₽
addToCartConversion number int32 Конверсия в корзину, % (Какой процент посетителей, открывших карточку товара, добавили товар в корзину)
cartToOrderConversion integer int32 Конверсия в заказ, % (Какой процент посетителей, добавивших товар в корзину, сделали заказ)
buyoutPercent integer int32 Процент выкупа, % (Какой процент посетителей, заказавших товар, его выкупили. Без учёта товаров, которые еще доставляются покупателю)

Отчёт по параметрам поиска. По предметам, брендам и ярлыкам

Имя Поле Формат Описание
SubjectName string string Название предмета
SubjectID integer int32 ID категории
BrandName string string Название бренда
TagID integer int64 ID ярлыка
AveragePosition integer uint64 Средняя позиция в поиске в текущий период
OpenCard integer uint64 Количество переходов в карточку товара из поиска в текущий период
AddToCart integer uint64 Количество добавлений товара в корзину из поиска в текущий период
OpenToCart integer uint64 Конверсия в корзину из поиска в текущий период
Orders integer uint64 Заказали товар из поиска в текущий период
CartToOrder integer uint64 Конверсия в заказ из поиска в текущий период
Visibility integer uint64 Видимость товара в поиске в текущий период
AveragePositionPast integer uint64 Средняя позиция в поиске в предыдущий период (заполняется, если указан прошлый период)
OpenCardPast integer uint64 Количество переходов в карточку товара из поиска в предыдущий период (заполняется, если указан прошлый период)
AddToCartPast integer uint64 Количество добавлений товара в корзину из поиска в предыдущий период (заполняется, если указан прошлый период)
OpenToCartPast integer uint64 Конверсия в корзину из поиска в предыдущий период (заполняется, если указан прошлый период)
OrdersPast integer uint64 Заказали товар из поиска в предыдущий период (заполняется, если указан прошлый период)
CartToOrderPast integer uint64 Конверсия в заказ из поиска в предыдущий период (заполняется, если указан прошлый период)
VisibilityPast integer uint64 Видимость товара в поиске в предыдущий период (заполняется, если указан прошлый период)

Отчёт по параметрам поиска. По артикулам WB

Имя Поле Формат Описание
NmID integer int64 Артикул WB
VendorCode string string Артикул продавца
Name string string Название товара
SubjectName string string Название предмета
BrandName string string Название бренда
IsAdvertised boolean bool Флаг, указывающий, рекламируется ли товар
IsRated boolean bool Флаг, указывающий, есть ли возможность оценить качество карточки товара
Rating float float64 Рейтинг карточки товара
FeedbackRating float float64 Рейтинг по отзывам
MinPrice integer uint64 Минимальная цена продавца со скидкой продавца (без учёта скидки по WB Клубу)
MaxPrice integer uint64 Максимальная цена продавца со скидкой продавца (без учёта скидки по WB Клубу)
AveragePosition integer uint64 Средняя позиция товара в поиске в текущий период
OpenCard integer uint64 Количество переходов в карточку товара из поиска в текущий период
AddToCart integer uint64 Количество добавлений товара в корзину из поиска в текущий период
OpenToCart integer uint64 Конверсия в корзину из поиска в текущий период
Orders integer uint64 Заказали товар из поиска в текущий период
CartToOrder integer uint64 Конверсия в заказ из поиска в текущий период
Visibility integer uint64 Видимость товара в поиске в текущий период
AveragePositionPast integer uint64 Средняя позиция товара в поиске в предыдущий период (заполняется, если указан прошлый период)
OpenCardPast integer uint64 Количество переходов в карточку товара из поиска в предыдущий период (заполняется, если указан прошлый период)
AddToCartPast integer uint64 Количество добавлений товара в корзину из поиска в предыдущий период (заполняется, если указан прошлый период)
OpenToCartPast integer uint64 Конверсия в корзину из поиска в предыдущий период (заполняется, если указан прошлый период)
OrdersPast integer uint64 Заказали товар из поиска в предыдущий период (заполняется, если указан прошлый период)
CartToOrderPast integer uint64 Конверсия в заказ из поиска в предыдущий период (заполняется, если указан прошлый период)
VisibilityPast integer uint64 Видимость товара в поиске в предыдущий период (заполняется, если указан прошлый период)

Response samples

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

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

Остатки на складах WB
Чтобы получить отчёт:

  1. Создайте его с помощью метода Создать отчёт.
  2. Загрузите отчёт с помощью метода Получить отчёт.

Создать отчёт

Создаёт задание на генерацию отчёта. Параметры 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 Schema: application/json
object (CreateTaskResponseData)

Response samples

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

Проверить статус

Возвращает статус задания на генерацию. Максимум 1 запрос в 5 секунд

Authorizations:
HeaderApiKey
path Parameters
task_id
required
string
Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2

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

Responses

Response Schema: application/json
object (GetTasksResponseData)

Response samples

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

Получить отчёт

Возвращает отчёт по ID задания. Максимум 1 запрос в минуту

Authorizations:
HeaderApiKey
path Parameters
task_id
required
string
Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2

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

Responses

Response Schema: application/json
Array
brand
string

Бренд

subjectName
string

Название предмета

vendorCode
string

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

nmId
integer

Артикул WB

barcode
string

Баркод

techSize
string

Размер

volume
number

Объём, л

inWayToClient
integer

В пути к клиенту

inWayFromClient
integer

В пути от клиента

quantityWarehousesFull
integer

Итоговые остатки по всем складам (сумма quantity)

Array of objects

Склады. Склад будет в ответе только при ненулевом остатке

Response samples

Content type
application/json
[
  • {
    }
]

Товары с обязательной маркировкой

Отчёт по товарам с обязательной маркировкой

Возвращает операции по маркируемым товарам. Максимум 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

Response Schema: application/json
object (models.ExciseReportResponse)

Request samples

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

Response samples

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

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

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

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

Создать отчёт

Создаёт задание на генерацию отчёта. Можно получить отчёт максимум за 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 Schema: application/json
object (CreateTaskResponseData)

Response samples

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

Проверить статус

Возвращает статус задания на генерацию. Максимум 1 запрос в 5 секунд

Authorizations:
HeaderApiKey
path Parameters
task_id
required
string
Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2

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

Responses

Response Schema: application/json
object (GetTasksResponseData)

Response samples

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

Получить отчёт

Возвращает отчёт по ID задания. Максимум 1 запрос в минуту

Authorizations:
HeaderApiKey
path Parameters
task_id
required
string
Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2

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

Responses

Response Schema: application/json
Array
date
string

Дата, за которую был расчёт или перерасчёт

logWarehouseCoef
number

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

officeId
integer

ID склада

warehouse
string

Название склада

warehouseCoef
number

Коэффициент склада

giId
integer

ID поставки

chrtId
integer

ID размера для этого артикула WB

size
string

Размер (techSize в карточке товара)

barcode
string

Баркод

subject
string

Предмет

brand
string

Бренд

vendorCode
string

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

nmId
integer

Артикул WB

volume
number

Объём товара

calcType
string

Способ расчёта

warehousePrice
number

Сумма хранения

barcodesCount
integer

Количество единиц товара (штук), подлежащих тарифицированию за расчётные сутки

palletPlaceCode
integer

Код паллетоместа

palletCount
number

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

originalDate
string

Если был перерасчёт, это дата первоначального расчёта. Если перерасчёта не было, совпадает с date

loyaltyDiscount
number

Скидка программы лояльности, ₽

tariffFixDate
string

Дата фиксации тарифа

tariffLowerDate
string

Дата понижения тарифа

Response samples

Content type
application/json
[
  • {
    }
]

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

Получить отчёт

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

Максимум 1 запрос в минуту

Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string
Example: dateFrom=2023-12-01

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

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

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

Responses

Response Schema: application/json
Array of objects

Response samples

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

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

Самовыкупы

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

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

Максимум 10 запросов за 100 минут.

Authorizations:
HeaderApiKey
query Parameters
date
string
Example: date=2023-12-01

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

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

Responses

Response Schema: application/json
Array of objects

Response samples

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

Подмена товара

Возвращает отчёт об удержаниях за отправку не тех товаров, пустых коробок или коробок без товара, но с посторонними предметами. В таких случаях удерживается 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 Schema: application/json
Array of objects

Response samples

Content type
application/json
{}

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

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

Можно получить данные с 31.10.2022.

Максимум 1 запрос в минуту.

Как это работает

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

Как считается коэффициент

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

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

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

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

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

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

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

Authorizations:
HeaderApiKey
query Parameters
date
string
Example: date=2023-12-01

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

Responses

Response Schema: application/json
Array of objects

Response samples

Content type
application/json
{}

Маркировка товара

Возвращает отчёт о штрафах за отсутствие обязательной маркировки товаров.
В отчёте представлены фотографии товаров, на которых маркировка отсутствует либо не считывается.
Можно получить данные максимум за 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 Schema: application/json
Array of objects

Response samples

Content type
application/json
{}

Смена характеристик

Возвращает отчёт об удержаниях за смену характеристик товара. Если товары после приёмки не соответствуют заявленным цветам и размерам, и на складе их перемаркировали с правильными характеристиками, по таким товарам назначается штраф.
Можно получить отчёт максимум за 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 Schema: application/json
Array of objects

Response samples

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

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

Получить отчёт

Возвращает данные продаж, сгруппированные по регионам стран. Можно получить отчёт максимум за 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 Schema: application/json
Array of objects

Response samples

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

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

С помощью этих методов можно получать отчёт по доле бренда продавца в продажах

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

  1. Запросите перечень брендов.
  2. Запросите категории бренда.
  3. Получите отчёт.

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

Бренды продавца

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

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

  • продавались за последние 90 дней
  • есть на складе WB

Максимум 1 запрос в минуту

Authorizations:
HeaderApiKey

Responses

Response Schema: application/json
data
Array of strings

Список брендов

Response samples

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

Родительские категории бренда

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

Можно получить данные с 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 Schema: application/json
Array of objects

Категории бренда

Response samples

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

Получить отчёт

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

Можно получить данные с 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 Schema: application/json
Array of objects

Отчёт

Response samples

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

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

Заблокированные карточки

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

Максимум 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 Schema: application/json
Array of objects

Отчёт

Response samples

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

Скрытые из каталога

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

Максимум 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 Schema: application/json
Array of objects

Отчёт

Response samples

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

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

Получить отчёт

Возвращает перечень возвратов товаров продавцу. Одним запросом можно получить отчёт максимум за 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 Schema: application/json
Array of objects

Отчёт

Response samples

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

Динамика оборачиваемости

Метод загрузки отчётов о динамике оборачиваемости — ежедневная динамика.

Ежедневная динамика

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

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

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

dateTo
required
string <date>
Example: dateTo=2024-12-14

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

Responses

Response Schema: application/json
Array of objects

Отчёт

Response samples

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