Отчёты (reports)
Отчеты по товарам, удержаниям, платной приемке и платному хранению
Поставки{{ /api/v1/supplier/incomes }}
Authorizations:
query Parameters
dateFrom required | string <RFC3339> Дата и время последнего изменения по поставке.
|
Responses
Response samples
- 200
- 401
- 429
[- {
- "incomeId": 12345,
- "number": "",
- "date": "2022-05-08T00:00:54",
- "lastChangeDate": "2022-05-08T00:44:15.5",
- "supplierArticle": "ABCDEF",
- "techSize": "0",
- "barcode": "2000328074123",
- "quantity": 3,
- "totalPrice": 0,
- "dateClose": "2022-05-08T00:00:00",
- "warehouseName": "Подольск",
- "nmId": 1234567,
- "status": "Принято"
}
]
Склад{{ /api/v1/supplier/stocks }}
Возвращает остатки товаров на складах WB. Данные обновляются раз в 30 минут. Сервис статистики не хранит историю остатков товаров, поэтому получить данные о них можно только на текущий момент
Authorizations:
query Parameters
dateFrom required | string <RFC3339> Дата и время последнего изменения по товару.
|
Responses
Response samples
- 200
- 401
- 429
[- {
- "lastChangeDate": "2023-07-05T11:13:35",
- "warehouseName": "Краснодар",
- "supplierArticle": "443284",
- "nmId": 1439871458,
- "barcode": "2037401340280",
- "quantity": 33,
- "inWayToClient": 1,
- "inWayFromClient": 0,
- "quantityFull": 34,
- "category": "Посуда и инвентарь",
- "subject": "Формы для запекания",
- "brand": "X",
- "techSize": "0",
- "Price": 185,
- "Discount": 0,
- "isSupply": true,
- "isRealization": false,
- "SCCode": "Tech"
}
]
Заказы{{ /api/v1/supplier/orders }}
Возвращает заказы. Данные обновляются раз в 30 минут.
1 строка = 1 заказ = 1 единица товара. Для определения заказа рекомендуем использовать поле srid
.
Данные заказа хранятся 90 дней от даты заказа
Authorizations:
query Parameters
dateFrom required | string <RFC3339> Дата и время последнего изменения по заказу.
|
flag | integer Default: 0 Если параметр |
Responses
Response samples
- 200
- 400
- 401
- 429
[- {
- "date": "2022-03-04T18:08:31",
- "lastChangeDate": "2022-03-06T10:11:07",
- "warehouseName": "Подольск",
- "countryName": "Россия",
- "oblastOkrugName": "Центральный федеральный округ",
- "regionName": "Московская",
- "supplierArticle": "12345",
- "nmId": 1234567,
- "barcode": "123453559000",
- "category": "Бытовая техника",
- "subject": "Мультистайлеры",
- "brand": "Тест",
- "techSize": "0",
- "incomeID": 56735459,
- "isSupply": false,
- "isRealization": true,
- "totalPrice": 1887,
- "discountPercent": 18,
- "spp": 26,
- "finishedPrice": 1145,
- "priceWithDisc": 1547,
- "isCancel": true,
- "cancelDate": "2022-03-09T00:00:00",
- "orderType": "Клиентский",
- "sticker": "926912515",
- "gNumber": "34343462218572569531",
- "srid": "11.rf9ef11fce1684117b0nhj96222982382.3.0"
}
]
Продажи{{ /api/v1/supplier/sales }}
Возвращает продажи и возвраты. Данные обновляются раз в 30 минут.
1 строка = 1 заказ = 1 единица товара. Для определения заказа рекомендуем использовать поле srid
.
Данные заказа хранятся 90 дней от даты продажи
Authorizations:
query Parameters
dateFrom required | string <RFC3339> Дата и время последнего изменения по продаже/возврату.
|
flag | integer Default: 0 Если параметр |
Responses
Response samples
- 200
- 400
- 401
- 429
[- {
- "date": "2022-03-04T18:08:31",
- "lastChangeDate": "2022-03-06T10:11:07",
- "warehouseName": "Подольск",
- "countryName": "Россия",
- "oblastOkrugName": "Центральный федеральный округ",
- "regionName": "Московская",
- "supplierArticle": "12345",
- "nmId": 1234567,
- "barcode": "123453559000",
- "category": "Бытовая техника",
- "subject": "Мультистайлеры",
- "brand": "Тест",
- "techSize": "0",
- "incomeID": 56735459,
- "isSupply": false,
- "isRealization": true,
- "totalPrice": 1887,
- "discountPercent": 18,
- "spp": 20,
- "paymentSaleAmount": 93,
- "forPay": 1284.01,
- "finishedPrice": 1145,
- "priceWithDisc": 1547,
- "saleID": "S9993700024",
- "orderType": "Клиентский",
- "sticker": "926912515",
- "gNumber": "34343462218572569531",
- "srid": "11.rf9ef11fce1684117b0nhj96222982382.3.0"
}
]
Отчёт по товарам с обязательной маркировкой{{ /api/v1/analytics/excise-report }}
Возвращает операции по маркируемым товарам
Authorizations:
query Parameters
dateFrom required | string Начало отчётного периода в формате RFC3339. Можно передать дату или дату со временем. Примеры:
|
dateTo required | string Конец отчётного периода в формате RFC3339. Можно передать дату или дату со временем. Примеры:
|
Request Body schema: application/jsonoptional
countries | Array of strings Items Enum: "AM" "BY" "KG" "KZ" "RU" "UZ" Код стран по стандарту ISO 3166-2. Чтобы получить данные по всем странам, оставьте параметр пустым |
Responses
Request samples
- Payload
{- "countries": [
- "AM",
- "RU"
]
}
Response samples
- 200
- 401
- 429
{- "response": {
- "data": [
- {
- "name": "Россия",
- "price": 100,
- "currency_name_short": "руб",
- "excise_short": "0102900254680370215_Re/=lSbNiGD",
- "barcode": 2038893425820,
- "nm_id": 169085355,
- "operation_type_id": 1,
- "fiscal_doc_number": 12345678,
- "fiscal_dt": "2024-01-01",
- "fiscal_drive_number": "string",
- "rid": 606217433440,
- "srid": "7513432034713632943.1.0"
}
]
}
}
Чтобы загрузить отчёт об остатках на складах WB:
- Создайте отчёт.
- Дождитесь, когда отчёт будет готов. Вы можете проверить статус готовности отчета. Готовый отчёт хранится 2 часа.
- Получите отчёт.
Создать отчёт{{ /api/v1/warehouse_remains }}
Создаёт задание на генерацию отчёта. Параметры groupBy
и filter
можно задать в любой комбинации — аналогично версии в личном кабинете.
Authorizations:
query Parameters
locale | string Default: "ru" Example: locale=ru Язык полей ответа
|
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. Если |
groupByBarcode | boolean Default: "false" Example: groupByBarcode=true Разбивка по баркодам |
groupBySize | boolean Default: "false" Example: groupBySize=true Разбивка по размерам |
filterPics | integer Default: "0" Example: filterPics=1 Фильтр по фото:
|
filterVolume | integer Default: "0" Example: filterVolume=3 Фильтр по объёму:
|
Responses
Response samples
- 200
- 400
- 401
- 429
{- "data": {
- "taskId": "219eaecf-e532-4bd8-9f15-8036ec1b042d"
}
}
Проверить статус{{ /api/v1/warehouse_remains/tasks/{task_id}/status }}
Возвращает статус задания на генерацию
Authorizations:
path Parameters
task_id required | string Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2 ID задания на генерацию |
Responses
Response samples
- 200
- 400
- 401
- 429
{- "data": {
- "id": "cad56ec5-91ec-43a2-b5e8-efcf244cf309",
- "status": "done"
}
}
Получить отчёт{{ /api/v1/warehouse_remains/tasks/{task_id}/download }}
Возвращает отчёт по ID задания
Authorizations:
path Parameters
task_id required | string Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2 ID задания на генерацию |
Responses
Response samples
- 200
- 400
- 401
- 429
[- {
- "brand": "Wonderful",
- "subjectName": "Фотоальбомы",
- "vendorCode": "41058/прозрачный",
- "nmId": 183804172,
- "barcode": "2037031652319",
- "techSize": "0",
- "volume": 1.33,
- "inWayToClient": 31,
- "inWayFromClient": 24,
- "quantityWarehousesFull": 134,
- "warehouses": [
- {
- "warehouseName": "Невинномысск",
- "quantity": 134
}
]
}
]
Самовыкупы{{ /api/v1/analytics/antifraud-details }}
Возвращает отчёт по удержаниям за самовыкупы. Отчёт формируется каждую неделю по средам, до 7:00 по московскому времени, и содержит данные за одну неделю. Можно получить отчёт за всё время с августа 2023.
Удержание за самовыкуп — 30% от стоимости товаров. Минимальная сумма всех удержаний — 100 000 ₽, если за неделю в ПВЗ привезли больше ваших товаров, чем на 100 000 ₽
Authorizations:
query Parameters
date | string Example: date=2023-12-01 Дата, которая входит в отчётный период, |
Responses
Response samples
- 200
- 400
- 401
- 429
{- "details": [
- {
- "nmID": 123456789,
- "sum": 3540,
- "currency": "RUB",
- "dateFrom": "2023-08-23",
- "dateTo": "2023-08-29"
}
]
}
Подмена товара{{ /api/v1/analytics/incorrect-attachments }}
Возвращает отчёт об удержаниях за отправку не тех товаров, пустых коробок или коробок без товара, но с посторонними предметами. В таких случаях удерживается 100% от стоимости заказа.
Можно получить отчёт максимум за 31 день. Доступны данные с июня 2023
Authorizations:
query Parameters
dateFrom required | string Example: dateFrom=2023-12-01 Начало отчётного периода, |
dateTo required | string Example: dateTo=2023-12-15 Конец отчётного периода, |
Responses
Response samples
- 200
- 400
- 401
- 429
{- "report": [
- {
- "amount": 24514.5,
- "date": "2023-12-15",
- "lostReason": "Подмена. Вместо большой железной дороги поступила маленькая коробка.",
- "nmID": 123456789,
- "shkID": 14555724540
}
]
}
Коэффициент логистики и хранения{{ /api/v1/analytics/storage-coefficient }}
Возвращает коэффициенты логистики и хранения. Они рассчитываются на неделю, с понедельника по воскресенье.
В начале каждой недели для продавца рассчитывается новый коэффициент логистики и хранения. Затем стоимость логистики и хранения умножается на коэффициент этой недели.
Коэффициент считается на основе расхождения фактических и заявленных габаритов упаковки товара:
Измеряем товары.
Работники склада измеряют по одному товару каждого наименования с учётом упаковки (кроме товаров меньше 2 литров). Для расчёта используются измерения за 30 дней до начала текущей недели.Считаем коэффициент для товара.
Результаты измерений сравниваются с габаритами из карточки товара. В зависимости от разницы каждому наименованию присваивается коэффициент по товару.Считаем коэффициент логистики и хранения.
Коэффициент логистики и хранения — это средний коэффициент по товарам.
Коэффициент логистики и хранения равен 1, если:
- По товарам продавца сделано меньше 10 уникальных измерений
- Средняя разница в габаритах не больше 10%
Для продавцов с коэффициентом 1 стоимость логистики и хранения не увеличивается.
Можно получить данные с 31 октября 2022
Authorizations:
query Parameters
date | string Example: date=2023-12-01 Дата, которая входит в отчётный период, |
Responses
Response samples
- 200
- 400
- 401
- 429
{- "report": [
- {
- "actualHeight": 6,
- "actualLength": 39,
- "actualVolume": 7.02,
- "actualWidth": 30,
- "date": "2023-04-11T12:21:19Z",
- "dimensionDifference": 101.74,
- "height": 10,
- "length": 30,
- "logWarehouseCoef": 1,
- "nmID": 123456789,
- "title": "Сухой корм для крупных собак ассорти мясное, 10 кг",
- "volume": 6.9,
- "width": 23
}
]
}
Маркировка товара{{ /api/v1/analytics/goods-labeling }}
Возвращает отчёт о штрафах за отсутствие обязательной маркировки товаров. В отчёте представлены фотографии товаров, на которых маркировка отсутствует либо не считывается. Можно получить данные максимум за 31 день, доступны данные с марта 2024
Authorizations:
query Parameters
dateFrom required | string <date> Example: dateFrom=2024-04-01 Начало отчётного периода, |
dateTo required | string <date> Example: dateTo=2024-04-30 Конец отчётного периода, |
Responses
Response samples
- 200
- 400
- 401
- 429
{- "report": [
- {
- "amount": 1500,
- "date": "2024-03-26T01:00:00Z",
- "incomeId": 18484008,
- "nmID": 49434732,
- "photoUrls": [
], - "shkID": 17346434621,
- "sku": "4630153500834"
}
]
}
Смена характеристик{{ /api/v1/analytics/characteristics-change }}
Возвращает отчёт об удержаниях за смену характеристик товара. Если товары после приёмки не соответствуют заявленным цветам и размерам, и на складе их перемаркировали с правильными характеристиками, по таким товарам назначается штраф. Можно получить отчёт максимум за 31 день, доступны данные с 28 декабря 2021
Authorizations:
query Parameters
dateFrom required | string <date> Example: dateFrom=2024-04-01 Начало отчётного периода, |
dateTo required | string <date> Example: dateTo=2024-04-30 Конец отчётного периода, |
Responses
Response samples
- 200
- 400
- 401
- 429
{- "report": [
- {
- "amount": 135890,
- "date": "2024-03-01T01:00:00Z",
- "newBarcode": "22222222222222",
- "newColor": "темно-синий,голубой",
- "newSa": "hjt13/темно-синий,голубой",
- "newShkID": 44444444444,
- "newSize": "80",
- "nmID": 123654789,
- "oldBarcode": "111111111111111",
- "oldColor": "темно-синий,голубой",
- "oldSa": "hjt13/темно-синий,голубой",
- "oldShkID": 333333333,
- "oldSize": "43"
}
]
}
Получить отчёт{{ /api/v1/analytics/acceptance-report }}
Возвращает даты и стоимость приёмки. Можно получить отчёт максимум за 31 день
Authorizations:
query Parameters
dateFrom required | string Example: dateFrom=2023-12-01 Начало отчётного периода, |
dateTo required | string Example: dateTo=2023-12-15 Конец отчётного периода, |
Responses
Response samples
- 200
- 400
- 401
- 429
{- "report": [
- {
- "count": 40,
- "giCreateDate": "2023-08-23",
- "incomeId": 11834106,
- "nmID": 123456789,
- "shkСreateDate": "2023-04-10",
- "subjectName": "Добавки пищевые",
- "total": 200.5
}
]
}
Чтобы получить отчёт:
- Сгенерируйте отчёт
- Дождитесь, когда отчёт будет готов. Вы можете проверить статус готовности отчёта. Готовый отчёт хранится 2 часа, после чего его нельзя будет получить.
- Получите отчёт
Создать отчёт{{ /api/v1/paid_storage }}
Создаёт задание на генерацию отчёта. Можно получить отчёт максимум за 8 дней
Authorizations:
query Parameters
dateFrom required | string Example: dateFrom=2022-01-01 Начало отчётного периода в формате RFC3339. Можно передать дату или дату со временем. Примеры:
|
dateTo required | string Example: dateTo=2022-01-09 Конец отчётного периода в формате RFC3339. Можно передать дату или дату со временем. Примеры:
|
Responses
Response samples
- 200
- 400
- 401
- 429
{- "data": {
- "taskId": "219eaecf-e532-4bd8-9f15-8036ec1b042d"
}
}
Проверить статус{{ /api/v1/paid_storage/tasks/{task_id}/status }}
Возвращает статус задания на генерацию отчёта
Authorizations:
path Parameters
task_id required | string Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2 ID задания на генерацию |
Responses
Response samples
- 200
- 401
- 429
{- "data": {
- "id": "cad56ec5-91ec-43a2-b5e8-efcf244cf309",
- "status": "done"
}
}
Получить отчёт{{ /api/v1/paid_storage/tasks/{task_id}/download }}
Возвращает отчёт по ID задания
Authorizations:
path Parameters
task_id required | string Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2 ID задания на генерацию |
Responses
Response samples
- 200
- 401
- 429
[- {
- "date": "2023-10-01",
- "logWarehouseCoef": 1,
- "officeId": 507,
- "warehouse": "Коледино",
- "warehouseCoef": 1.7,
- "giId": 123456,
- "chrtId": 1234567,
- "size": "0",
- "barcode": "",
- "subject": "Маски одноразовые",
- "brand": "1000 Каталог",
- "vendorCode": "567383",
- "nmId": 1234567,
- "volume": 12,
- "calcType": "короба: без габаритов",
- "warehousePrice": 7.65,
- "barcodesCount": 1,
- "palletPlaceCode": 0,
- "palletCount": 0,
- "originalDate": "2023-03-01",
- "loyaltyDiscount": 10,
- "tariffFixDate": "2023-10-01",
- "tariffLowerDate": "2023-11-01"
}
]
Получить отчёт{{ /api/v1/analytics/region-sale }}
Возвращает данные продаж, сгруппированные по регионам стран. Можно получить отчёт максимум за 31 день.
Authorizations:
query Parameters
dateFrom required | string Example: dateFrom=2023-12-01 Начало отчётного периода, |
dateTo required | string Example: dateTo=2023-12-15 Конец отчётного периода, |
Responses
Response samples
- 200
- 400
- 401
- 429
{- "report": [
- {
- "cityName": "деревня Суханово",
- "countryName": "Россия",
- "foName": "Центральный федеральный округ",
- "nmID": 177974431,
- "regionName": "Московская область",
- "sa": "112233445566778899",
- "saleInvoiceCostPrice": 592.11,
- "saleInvoiceCostPricePerc": 43.0547333297454,
- "saleItemInvoiceQty": 4
}
]
}
Отчёты по доле бренда продавца в продажах.
Для получения отчёта вам понадобятся:
Можно получить отчёт максимум за год
Заблокированные карточки{{ /api/v1/analytics/banned-products/blocked }}
Возвращает список заблокированных карточек
Authorizations:
query Parameters
sort required | string Enum: "brand" "nmId" "title" "vendorCode" "reason" Example: sort=nmId Сортировка
|
order required | string Enum: "desc" "asc" Example: order=asc Порядок выдачи
|
Responses
Response samples
- 200
- 400
- 401
- 429
{- "report": [
- {
- "brand": "Тест22",
- "nmId": 82722944,
- "title": "Гуминовые кислоты - биоактивный противовирусный комплекс на",
- "vendorCode": "пкdeир76",
- "reason": "Контактные данные Продавца и ссылки на иные сайты/группы/сообщества на фотографиях Товара"
}
]
}
Скрытые из каталога{{ /api/v1/analytics/banned-products/shadowed }}
Возвращает список товаров, скрытых из каталога
Authorizations:
query Parameters
sort required | string Enum: "brand" "nmId" "title" "vendorCode" "nmRating" Example: sort=title Сортировка
|
order required | string Enum: "desc" "asc" Example: order=desc Порядок выдачи
|
Responses
Response samples
- 200
- 400
- 401
- 429
{- "report": [
- {
- "brand": "Трикотаж",
- "nmId": 166658151,
- "title": "ВАЗ",
- "vendorCode": "DP02/черный",
- "nmRating": 3.1
}
]
}
Получить отчёт{{ /api/v1/analytics/goods-return }}
Возвращает перечень возвратов товаров продавцу. Одним запросом можно получить отчёт максимум за 31 день.
Authorizations:
query Parameters
dateFrom required | string <date> Example: dateFrom=2024-08-13 Дата начала отчётного периода |
dateTo required | string <date> Example: dateTo=2024-08-27 Дата окончания отчётного периода |
Responses
Response samples
- 200
- 400
- 401
- 429
{- "report": [
- {
- "barcode": "1680063403480",
- "brand": "dub",
- "dstOfficeAddress": "Жуковский Улица Маяковского 19",
- "dstOfficeId": 310105,
- "isStatusActive": 0,
- "nmId": 12862181,
- "orderDt": "2024-08-26",
- "returnType": "Возврат заблокированного товара",
- "shkId": 23411783472,
- "srid": "f4f02193-289d-4303-aead-73b5b6d40dd9.99",
- "status": "В пути в пвз",
- "stickerId": "33811984302",
- "subjectName": "Багажные бирки",
- "techSize": "0"
}
]
}