Search
API docs by Redocly

Reports (reports)

Reports on products, retentions, paid reception, and paid storage

Reports

Reports on products, retentions, paid reception, and paid storage

Product Reports

To access the methods, use a token for the Statistics category
You can save reports in Excel format

Supplies{{ /api/v1/supplier/incomes }}

Описание метода
Maximum of 1 request per minute per one seller's account
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Date and time of last change on the supplie.
Date format: RFC3339. You may send date or date with time. Time could be specified in seconds or milliseconds.
The time stands in Moscow time zone (UTC+3).
Examples:

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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.

Maximum of 1 request per minute per one seller's account
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Date and time of last change on the product.
The earliest possible value should be entered to get the total leftover, e.g. 2019-06-20. Date format: RFC3339. You may send date or date with time. Time could be specified in seconds or milliseconds.
The time stands in Moscow time zone (UTC+3).
Examples:

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Maximum of 1 request per minute per one seller's account
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Date and time of last change on the order.
Date format: RFC3339. You may send date or date with time. Time could be specified in seconds or milliseconds.
The time stands in Moscow time zone (UTC+3).
Examples:

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

flag
integer
Default: 0

If parameter flag=0 (or it doesn't exist in requests string), then call of API methods returns data, which value of field lastChangeDate (date and time of refreshing info of service) is greater or equal to the given parameter value dateFrom. In this case the number of returned rows of data varies from 0 to approximately 100,000.
If parameter flag=1, then information about all orders or sales with the date will be uploaded, that equals to the passed parameter dateFrom (in this case the time in the date doesn't matter). Also the number of returned rows of data will be equal to the number of all orders or sales that were made on the specified date, passed in the dateFrom parameter.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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.

Maximum of 1 request per minute per one seller's account
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Date and time of last change on the sale/return.
Date format: RFC3339. You may send date or date with time. Time could be specified in seconds or milliseconds.
The time stands in Moscow time zone (UTC+3).
Examples:

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

flag
integer
Default: 0

If parameter flag=0 (or it doesn't exist in requests string), then call of API methods returns data, which value of field lastChangeDate (date and time of refreshing info of service) is greater or equal to the given parameter value dateFrom. In this case the number of returned rows of data varies from 0 to approximately 100,000.
If parameter flag=1, then information about all orders or sales with the date will be uploaded, that equals to the passed parameter dateFrom (in this case the time in the date doesn't matter). Also the number of returned rows of data will be equal to the number of all orders or sales that were made on the specified date, passed in the dateFrom parameter.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Report on products with mandatory labeling{{ /api/v1/analytics/excise-report }}

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

Returns operations with labeled products

Maximum of 10 requests per 5 hours per one seller's account
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string

Start of the reporting period in RFC3339 format. You can provide a date or a date with time. Examples:

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

End of the reporting period in RFC3339 format. You can provide a date or a date with time. Examples:

  • 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"

Country code in according with ISO 3166-2. Set the empty parameter to get data without filters by country

Responses

Request samples

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

Response samples

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

Warehouses Remains Report

To access the methods, use a token for the Analytics category

To download the report on WB warehouses remains:

  1. Create the report.
  2. Wait for the report to be ready. You can check the status of the report readiness. The ready report is stored for 2 hours.
  3. 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.

Maximum of 1 request per minute per one seller's account
Authorizations:
HeaderApiKey
query Parameters
locale
string
Default: "ru"
Example: locale=ru

Language of the subjectName and warehouseName response fields:

  • ru — Russian
  • en — English
  • zh — Chinese. Values of the warehouseName are in English
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 groupByNm=true, there will be volume field in the response

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:

  • -1 — without photo
  • 0 — do not apply filter
  • 1 — with photo
filterVolume
integer
Default: "0"
Example: filterVolume=3

Volume filter:

  • -1 — without dimensions
  • 0 — do not apply filter
  • 3 — over three liters

Responses

Response samples

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

Check the status{{ /api/v1/warehouse_remains/tasks/{task_id}/status }}

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

Returns the status of the generation task

Maximum of 1 request per 5 seconds per one seller's account
Authorizations:
HeaderApiKey
path Parameters
task_id
required
string
Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2

Generation task ID

Responses

Response samples

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

Get the report{{ /api/v1/warehouse_remains/tasks/{task_id}/download }}

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

Returns the report by task ID

Maximum of 1 request per minute per one seller's account
Authorizations:
HeaderApiKey
path Parameters
task_id
required
string
Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2

Generation task ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retention Reports

To access the methods, use a token for the Analytics category

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.

Maximum of 10 requests per 100 minutes per one seller's account
Authorizations:
HeaderApiKey
query Parameters
date
string

Date from report period, YYYY-MM-DD, for example 2023-12-01. To get all data from August 2023 do not use this parameter

Responses

Response samples

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

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 of report period is 31 days, data is available starting from June 2023.

Maximum of 1 request per minute per one seller's account
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string

Report period start, YYYY-MM-DD

dateTo
required
string

Report period end, YYYY-MM-DD

Responses

Response samples

Content type
application/json
{}

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:

  1. 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.

  2. 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.

  3. 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.

Maximum of 1 request per minute per one seller's account
Authorizations:
HeaderApiKey
query Parameters
date
string

Date from report period, YYYY-MM-DD, for example 2023-12-01.

Responses

Response samples

Content type
application/json
{}

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

Maximum of 10 requests per 10 minutes per one seller's account
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <date>
Example: dateFrom=2024-04-01

Report period start, YYYY-MM-DD

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

Report period end, YYYY-MM-DD

Responses

Response samples

Content type
application/json
{}

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.

Maximum of 10 requests per 10 minutes per one seller's account
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <date>
Example: dateFrom=2024-04-01

Report period start, YYYY-MM-DD

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

Report period end, YYYY-MM-DD

Responses

Response samples

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

Paid Reception

To access the methods, use a token for the Analytics category

Paid receiving report{{ /api/v1/analytics/acceptance-report }}

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

Returns dates and cost of the receiving. Maximum of report period is 31 days

Maximum of 1 request per minute per one seller's account
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string

Report period start, YYYY-MM-DD

dateTo
required
string

Report period end, YYYY-MM-DD

Responses

Response samples

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

Paid Storage

To access the methods, use a token for the Analytics category

To get a report:

  1. Generate the report
  2. Check if the report is generated with Check the status method. Generated report is available during 2 hours.
  3. Get the report

Generate the report{{ /api/v1/paid_storage }}

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

Create a task to generate a report. Maximum of report period — 8 days

Maximum of 1 request per minute per one seller's account
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string
Example: dateFrom=2022-01-01

Start of the report period, RFC3339 format. Date or date and time, for example:

  • 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

End of the report period, RFC3339 format. Date or date and time, for example:

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

Responses

Response samples

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

Check the status{{ /api/v1/paid_storage/tasks/{task_id}/status }}

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

Returns the status of task

Maximum of 1 request per 5 seconds per one seller's account
Authorizations:
HeaderApiKey
path Parameters
task_id
required
string
Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2

Task ID

Responses

Response samples

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

Get the report{{ /api/v1/paid_storage/tasks/{task_id}/download }}

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

Returns the report by task ID

Maximum of 1 request per minute per one seller's account
Authorizations:
HeaderApiKey
path Parameters
task_id
required
string
Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2

Task ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales by Regions

To access the methods, use a token for the Analytics category

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.

Maximum of 1 request per 10 seconds per one seller's account
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string

Report period start, YYYY-MM-DD

dateTo
required
string

Report period end, YYYY-MM-DD

Responses

Response samples

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

Share of Brand in Sales

To access the methods, use a token for the Analytics category

Reports on the seller's brand share in sales.

To obtain a report, you will need:

  1. Brand names.
  2. ID and names of categories.

You can get a report for a maximum of one year

Seller brands{{ /api/v1/analytics/brand-share/brands }}

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

Returns the list of the seller brands.

You can only get brands that:

  • were sold in the last 90 days
  • are in WB
Maximum of 1 request per minute per one seller's account
Authorizations:
HeaderApiKey

Responses

Response samples

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

Parent categories of the brand{{ /api/v1/analytics/brand-share/parent-subjects }}

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

Returns parent categories of the brand.

Data can be obtained starting from 1 November 2022, for up to 365 days.

Maximum of 1 request per 5 seconds per one seller's account
Authorizations:
HeaderApiKey
query Parameters
locale
string
Default: "ru"
Example: locale=ru

Language of the response field parentName:

  • ru — Russian
  • en — English
  • zh — Chinese
brand
required
string
Example: brand=H%26M

Brand

dateFrom
required
string

Report period start, YYYY-MM-DD

dateTo
required
string

Report period end, YYYY-MM-DD

Responses

Response samples

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

Get report{{ /api/v1/analytics/brand-share }}

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

Returns a report on the brand's share in sales.

Data can be obtained starting from 1 November 2022, for up to 365 days.

Maximum of 1 request per 5 seconds per one seller's account
Authorizations:
HeaderApiKey
query Parameters
parentId
required
integer
Example: parentId=1

Parent category ID

brand
required
string
Example: brand=H%26M

Brand

dateFrom
required
string

Report period start, YYYY-MM-DD

dateTo
required
string

Report period end, YYYY-MM-DD

Responses

Response samples

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

Hidden Products

To access the methods, use a token for the Analytics category

Blocked product cards{{ /api/v1/analytics/banned-products/blocked }}

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

Returns the list of blocked product cards

Maximum of 1 request per 10 seconds per one seller's account
Authorizations:
HeaderApiKey
query Parameters
sort
required
string
Enum: "brand" "nmId" "title" "vendorCode" "reason"
Example: sort=nmId

Sorting

  • brand — by brand
  • nmId — by WB article
  • title — by product title
  • vendorCode — by seller's article
  • reason — by reason for blocking
order
required
string
Enum: "desc" "asc"
Example: order=asc

Data order

  • desc — from the largest numeric value to the smallest, from the last alphabetical value to the first
  • asc — from the smallest numeric value to the largest, from the first alphabetical value to the last

Responses

Response samples

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

Hidden from the catalog{{ /api/v1/analytics/banned-products/shadowed }}

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

Returns the list of products hidden from the catalog

Maximum of 1 request per 10 seconds per one seller's account
Authorizations:
HeaderApiKey
query Parameters
sort
required
string
Enum: "brand" "nmId" "title" "vendorCode" "nmRating"
Example: sort=title

Sorting

  • brand — by brand
  • nmId — by WB article
  • title — by product title
  • vendorCode — by seller's article
  • nmRating — by card rating
order
required
string
Enum: "desc" "asc"
Example: order=desc

Data order

  • desc — from the largest numeric value to the smallest, from the last alphabetical value to the first
  • asc — from the smallest numeric value to the largest, from the first alphabetical value to the last

Responses

Response samples

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

Goods Return Report

To access the methods, use a token for the Analytics category

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.

Maximum of 1 request per minute per one seller's account
Authorizations:
HeaderApiKey
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

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

Turnover Dynamics

To access the methods, use a token for the Analytics category

Method for retrieving reports on turnover dynamics — daily dynamics.

Daily dynamics{{ /api/v1/turnover-dynamics/daily-dynamics }}

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

Method provides data on daily dynamics.

You can obtain a report for a maximum of 31 days.

Maximum of 1 request per 10 seconds per one seller's account
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <date>
Example: dateFrom=2024-12-11

Start date of the reporting period

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

End date of the reporting period

Responses

Response samples

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