Reports (reports)
Reports on products, retentions, paid reception, and paid storage
Supplies{{ /api/v1/supplier/incomes }}
Authorizations:
query Parameters
dateFrom required | string <RFC3339> Date and time of last change on the supplie.
|
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": "Принято"
}
]
Warehouse{{ /api/v1/supplier/stocks }}
WB stock product leftover. The data is updated every 30 minutes. The statistics service does not keep a history of product leftovers, so you can only retrieve data about them in 'real time' mode.
Authorizations:
query Parameters
dateFrom required | string <RFC3339> Date and time of last change on the product.
|
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"
}
]
Orders{{ /api/v1/supplier/orders }}
Orders.
Storage of data for orders is guaranteed for no more than 90 days from the date of order.
The data is updated every 30 minutes.
To identify goods from one order, as well as sales on them, you should use
Authorizations:
query Parameters
dateFrom required | string <RFC3339> Date and time of last change on the order.
|
flag | integer Default: 0 If parameter |
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"
}
]
Sales{{ /api/v1/supplier/sales }}
Sales and returns.
Data storage is guaranteed for no more than 90 days from the date of sale.
The data updated every 30 minutes.
The srid
field should be used to identify the order.
1 line means 1 sale/return and means 1 item.
Authorizations:
query Parameters
dateFrom required | string <RFC3339> Date and time of last change on the sale/return.
|
flag | integer Default: 0 If parameter |
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"
}
]
Report on products with mandatory labeling{{ /api/v1/analytics/excise-report }}
Returns operations with labeled products
Authorizations:
query Parameters
dateFrom required | string Start of the reporting period in RFC3339 format. You can provide a date or a date with time. Examples:
|
dateTo required | string End of the reporting period in RFC3339 format. You can provide a date or a date with time. Examples:
|
Request Body schema: application/jsonoptional
countries | Array of strings Items Enum: "AM" "BY" "KG" "KZ" "RU" "UZ" Country code in according with ISO 3166-2. Set the empty parameter to get data without filters by country |
Responses
Request samples
- Payload
{- "countries": [
- "AM",
- "RU"
]
}
Response samples
- 200
- 401
- 429
{- "response": {
- "data": [
- {
- "name": "Россия",
- "price": 100,
- "currency_name_short": "AMD",
- "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"
}
]
}
}
To download the report on WB warehouses remains:
- Create the report.
- Wait for the report to be ready. You can check the status of the report readiness. The ready report is stored for 2 hours.
- Get the report.
Create the report{{ /api/v1/warehouse_remains }}
Creates a task for report generation. The parameters groupBy
and filter
can be set in any combination — similar to the version in the personal account.
Authorizations:
query Parameters
locale | string Default: "ru" Example: locale=ru Language of the
|
groupByBrand | boolean Default: "false" Example: groupByBrand=true Group by brand |
groupBySubject | boolean Default: "false" Example: groupBySubject=true Group by subject |
groupBySa | boolean Default: "false" Example: groupBySa=true Group by seller's article |
groupByNm | boolean Default: "false" Example: groupByNm=true Group by WB article. If |
groupByBarcode | boolean Default: "false" Example: groupByBarcode=true Group by barcode |
groupBySize | boolean Default: "false" Example: groupBySize=true Group by size |
filterPics | integer Default: "0" Example: filterPics=1 Photo filter:
|
filterVolume | integer Default: "0" Example: filterVolume=3 Volume filter:
|
Responses
Response samples
- 200
- 400
- 401
- 429
{- "data": {
- "taskId": "219eaecf-e532-4bd8-9f15-8036ec1b042d"
}
}
Check the status{{ /api/v1/warehouse_remains/tasks/{task_id}/status }}
Returns the status of the generation task
Authorizations:
path Parameters
task_id required | string Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2 Generation task ID |
Responses
Response samples
- 200
- 400
- 401
- 429
{- "data": {
- "id": "cad56ec5-91ec-43a2-b5e8-efcf244cf309",
- "status": "done"
}
}
Get the report{{ /api/v1/warehouse_remains/tasks/{task_id}/download }}
Returns the report by task ID
Authorizations:
path Parameters
task_id required | string Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2 Generation task 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
}
]
}
]
Self-purchases{{ /api/v1/analytics/antifraud-details }}
Returns report with self-purchase deductions. The report is generated on Wednesdays at 7:00 UTC+4 and contains weekly data. Also you can get all data starting from August 2023.
Self-purchase deduction is 30% of product price. Minimum deduction is 100,000 ₽, if the total product cost delivered to the pick-up point is more than 100,000 ₽ per one week.
Authorizations:
query Parameters
date | string Date from report period, |
Responses
Response samples
- 200
- 400
- 401
- 429
{- "details": [
- {
- "nmID": 123456789,
- "sum": 3540,
- "currency": "RUB",
- "dateFrom": "2023-08-23",
- "dateTo": "2023-08-29"
}
]
}
Substitutions{{ /api/v1/analytics/incorrect-attachments }}
Returns deductions for wrong products, empty boxes and boxes without ordered products but with some other things. Deduction is 100% of order sum.
Maximum report period is 31 days, data is available starting from June 2023.
Authorizations:
query Parameters
dateFrom required | string Report period start, |
dateTo required | string Report period end, |
Responses
Response samples
- 200
- 400
- 401
- 429
{- "report": [
- {
- "amount": 24514.5,
- "date": "2023-12-15",
- "lostReason": "Подмена. Вместо большой железной дороги поступила маленькая коробка.",
- "nmID": 123456789,
- "shkID": 14555724540
}
]
}
Logistics and storage factor{{ /api/v1/analytics/storage-coefficient }}
Returns logistics and storage factor. They are calculated weekly.
You can get data starting from 31.10.2022.
About factor
The factor is calculated weekly, by Mondays. Then logistics and storage cost is multiplied by factor of this week.
How the factor is calculated
Based on difference between actual product dimensions and dimensions in the product card:
Measuring products.
Warehouse workers measure one item of each type, with its package (except for items less than 2 l). For the calculation, measurements from the 30 days before to the beginning of the current week are used.Product factor calculation.
The measurement results are compared with the dimensions from the product card. Depending on the difference, a factor is assigned to each item.Calculation of logistics and storage factor.
Logistics and storage factors is the average factor per product.
Logistics and storage factors is 1 in cases:
- For the seller's products, there were fewer than 10 unique measurements.
- The average difference in dimensions is not more than 10%.
For sellers with a factor equal 1, the cost of logistics and storage does not increase.
Authorizations:
query Parameters
date | string Date from report period, |
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
}
]
}
Product labeling{{ /api/v1/analytics/goods-labeling }}
Returns a report on deductions for the absence of mandatory product labeling.
The report contains photos of products where the labeling is absent or cannot be read.
Data can be obtained for up to 31 days, starting from March 2024
Authorizations:
query Parameters
dateFrom required | string <date> Example: dateFrom=2024-04-01 Report period start, |
dateTo required | string <date> Example: dateTo=2024-04-30 Report period end, |
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"
}
]
}
Characteristics change{{ /api/v1/analytics/characteristics-change }}
Returns a report on deductions for changing product characteristics. If any products do not match the declared colors and sizes after acceptance and are relabeled at the warehouse, a fine is imposed on these products.
Data can be obtained for up to 31 days, starting from 28 December 2021.
Authorizations:
query Parameters
dateFrom required | string <date> Example: dateFrom=2024-04-01 Report period start, |
dateTo required | string <date> Example: dateTo=2024-04-30 Report period end, |
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"
}
]
}
Paid receiving report{{ /api/v1/analytics/acceptance-report }}
Returns dates and cost of the receiving. Maximum report period is 31 days
Authorizations:
query Parameters
dateFrom required | string Report period start, |
dateTo required | string Report period end, |
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
}
]
}
To get a report:
- Generate the report
- Check if the report is generated with Check the status method. Generated report is available during 2 hours.
- Get the report
Generate the report{{ /api/v1/paid_storage }}
Create a task to generate a report. Maximum report period — 8 days
Authorizations:
query Parameters
dateFrom required | string Example: dateFrom=2022-01-01 Start of the report period, RFC3339 format. Date or date and time, for example:
|
dateTo required | string Example: dateTo=2022-01-09 End of the report period, RFC3339 format. Date or date and time, for example:
|
Responses
Response samples
- 200
- 400
- 401
- 429
{- "data": {
- "taskId": "219eaecf-e532-4bd8-9f15-8036ec1b042d"
}
}
Check the status{{ /api/v1/paid_storage/tasks/{task_id}/status }}
Returns the status of task
Authorizations:
path Parameters
task_id required | string Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2 Task ID |
Responses
Response samples
- 200
- 401
- 429
{- "data": {
- "id": "cad56ec5-91ec-43a2-b5e8-efcf244cf309",
- "status": "done"
}
}
Get the report{{ /api/v1/paid_storage/tasks/{task_id}/download }}
Returns the report by task ID
Authorizations:
path Parameters
task_id required | string Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2 Task 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"
}
]
Get report{{ /api/v1/analytics/region-sale }}
Returns sales data grouped by regions of the countries. You can obtain a report for a maximum of 31 days.
Authorizations:
query Parameters
dateFrom required | string Report period start, |
dateTo required | string Report period end, |
Responses
Response samples
- 200
- 400
- 401
- 429
{- "report": [
- {
- "cityName": "деревня Суханово",
- "countryName": "Россия",
- "foName": "Центральный федеральный округ",
- "nmID": 177974431,
- "regionName": "Московская область",
- "sa": "112233445566778899",
- "saleInvoiceCostPrice": 592.11,
- "saleInvoiceCostPricePerc": 43.0547333297454,
- "saleItemInvoiceQty": 4
}
]
}
Blocked product cards{{ /api/v1/analytics/banned-products/blocked }}
Authorizations:
query Parameters
sort required | string Enum: "brand" "nmId" "title" "vendorCode" "reason" Example: sort=nmId Sorting
|
order required | string Enum: "desc" "asc" Example: order=asc Data order
|
Responses
Response samples
- 200
- 400
- 401
- 429
{- "report": [
- {
- "brand": "Тест22",
- "nmId": 82722944,
- "title": "Гуминовые кислоты - биоактивный противовирусный комплекс на",
- "vendorCode": "пкdeир76",
- "reason": "Контактные данные Продавца и ссылки на иные сайты/группы/сообщества на фотографиях Товара"
}
]
}
Hidden from the catalog{{ /api/v1/analytics/banned-products/shadowed }}
Returns the list of products hidden from the catalog
Authorizations:
query Parameters
sort required | string Enum: "brand" "nmId" "title" "vendorCode" "nmRating" Example: sort=title Sorting
|
order required | string Enum: "desc" "asc" Example: order=desc Data order
|
Responses
Response samples
- 200
- 400
- 401
- 429
{- "report": [
- {
- "brand": "Трикотаж",
- "nmId": 166658151,
- "title": "ВАЗ",
- "vendorCode": "DP02/черный",
- "nmRating": 3.1
}
]
}
Get report{{ /api/v1/analytics/goods-return }}
Returns a list of goods returns to the seller. With one request, you can obtain a report for a maximum of 31 days.
Authorizations:
query Parameters
dateFrom required | string <date> Example: dateFrom=2024-08-13 Beginning date of the reporting period |
dateTo required | string <date> Example: dateTo=2024-08-27 End date of the reporting period |
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"
}
]
}