Search
API docs by Redocly

Reports (reports)

Reports on items, retentions, and paid storage

Reports

Reports on items, retentions, and paid storage

Main Reports

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

You can save the main reports in sheets format

Orders{{ /api/v1/supplier/orders }}

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

The method returns order information.
The data updated every 30 minutes.

1 line means 1 order and means 1 item.
The srid field should be used to identify the order.

Data storage is guaranteed for no more than 90 days from the date of sale.

The responses do not include orders for which payment was not confirmed. For example, it could be orders with delayed payments or installment payments. However, if there are sales for such orders, you can get it using details for the realization reports.
To receive all completed orders, use Order Feed.

The data in this report is preliminary and is used for operational monitoring

For a single response to a request with flag=0 or without flag, a conditional limit of 80,000 rows is set. Therefore, more than one request may be necessary to retrieve all orders. In the second and subsequent requests, use the full value of the lastChangeDate field of the last row from the response of the previous request in the dateFrom parameter.
If the response returns an empty array [], all orders have already been retrieved.

In the sandbox, the dateFrom and dateTo parameters can only be set to a range within the last 4 months from the current date.

Request limit per one seller account:
Type Period Limit Interval Burst
Personal 1 min 1 request 1 min 10 requests
Service 1 min 1 request 1 min 10 requests
Base with secret 1 min 1 request 1 min 10 requests
Base 3 h 1 request 3 h 1 request
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string

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 80,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 }}

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

The method returns sale and return information.
The data updated every 30 minutes.

1 line means 1 sale/return and means 1 item.
The srid field should be used to identify the order.

Data storage is guaranteed for no more than 90 days from the date of sale.

The data in this report is preliminary and is used for operational monitoring
  • The responses do not include orders for which payment was not confirmed, even if these orders are in details for the realization reports. For example, it could be orders with delayed payments or installment payments
  • The values of the priceWithDisc and forPay fields are calculated using a simplified logic and may differ from retail_price_withdisc_rub and ppvz_for_pay, respectively, in details for the realization reports
  • The fields finishedPrice, priceWithDisc, and forPay may temporarily have the value 0: data is filled in asynchronously and updated within 24 hours
  • For orders that are paid in a currency other than the seller currency, prices may be rounded due to currency conversion

Use details for the realization reports for accurate financial calculations, reconciliation, and reporting.

For a single response to a request with flag=0 or without flag, a conditional limit of 80,000 rows is set. Therefore, more than one request may be necessary to retrieve all sales and returns. In the second and subsequent requests, use the full value of the lastChangeDate field of the last row from the response of the previous request in the dateFrom parameter.
If the response returns an empty array [], all sales and returns have already been retrieved.

In the sandbox, the dateFrom and dateTo parameters can only be set to a range within the last 4 months from the current date.

Request limit per one seller account:
Type Period Limit Interval Burst
Personal 1 min 1 request 1 min 1 request
Service 1 min 1 request 1 min 1 request
Base with secret 1 min 1 request 1 min 1 request
Base 2 h 1 request 2 h 1 request
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string

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 80,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
[
  • {
    }
]

Warehouses Inventory Report

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

To get 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.

Request limit per one seller account:
Type Period Limit Interval Burst
Personal 1 min 1 request 1 min 5 requests
Service 1 min 1 request 1 min 5 requests
Base with secret 1 min 1 request 1 min 5 requests
Base 1 h 4 requests 15 min 1 request
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 subcategory

groupBySa
boolean
Default: false
Example: groupBySa=true

Group by seller item number

groupByNm
boolean
Default: false
Example: groupByNm=true

Group by WB item number. 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

Request limit per one seller account:
Type Period Limit Interval Burst
Personal 5 s 1 request 5 s 5 requests
Service 5 s 1 request 5 s 5 requests
Base with secret 5 s 1 request 5 s 5 requests
Base 1 h 4 requests 15 min 1 request
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

Request limit per one seller account:
Type Period Limit Interval Burst
Personal 1 min 1 request 1 min 1 request
Service 1 min 1 request 1 min 1 request
Base with secret 1 min 1 request 1 min 1 request
Base 1 h 4 requests 15 min 1 request
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

Logistics and Storage Costs Multiplier{{ /api/analytics/v1/measurement-penalties }}

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

The method returns a report with logistics and storage costs multiplier

Request limit per one seller account:
Type Period Limit Interval Burst
Personal 1 min 1 request 1 min 1 request
Service 1 min 1 request 1 min 1 request
Base with secret 1 min 1 request 1 min 1 request
Base 6 h 1 request 6 h 1 request
Authorizations:
HeaderApiKey
query Parameters
dateFrom
string <date-time>
Example: dateFrom=2025-02-01T15:00:00Z

Report period start. By default the date when data for the report was first received is used

dateTo
required
string <date-time>
Example: dateTo=2025-10-11T18:00:00Z

Report period end

limit
required
integer <= 1000
Example: limit=330

Number of retentions in the response

offset
integer
Default: 0
Example: offset=220

How many results to skip. For example, with value 10, the response will start with the 11 element

Responses

Response samples

Content type
application/json
{}

Warehouse Measurements{{ /api/analytics/v1/warehouse-measurements }}

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

The method returns a report with warehouse measurements

Request limit per one seller account:
Type Period Limit Interval Burst
Personal 1 min 1 request 1 min 1 request
Service 1 min 1 request 1 min 1 request
Base with secret 1 min 1 request 1 min 1 request
Base 6 h 1 request 6 h 1 request
Authorizations:
HeaderApiKey
query Parameters
dateFrom
string <date-time>
Example: dateFrom=2025-02-01T15:00:00Z

Report period start. By default the date when data for the report was first received is used

dateTo
required
string <date-time>
Example: dateTo=2025-10-11T18:00:00Z

Report period end

limit
required
integer <= 1000
Example: limit=330

Number of measurements in the response

offset
integer
Default: 0
Example: offset=220

How many results to skip. For example, with value 10, the response will start with the 11 element

Responses

Response samples

Content type
application/json
{}

Substitutions and Incorrect Attachments{{ /api/analytics/v1/deductions }}

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

The method returns a report with substitutions and incorrect attachments retentions

Request limit per one seller account:
Type Period Limit Interval Burst
Personal 1 min 1 request 1 min 1 request
Service 1 min 1 request 1 min 1 request
Base with secret 1 min 1 request 1 min 1 request
Base 1 h 4 requests 15 min 1 request
Authorizations:
HeaderApiKey
query Parameters
dateFrom
string <date-time>
Example: dateFrom=2025-02-01T15:00:00Z

Report period start. By default the date and time when data for the report was first received is used

dateTo
required
string <date-time>
Example: dateTo=2025-10-11T18:00:00Z

Report period end

sort
string
Default: "dtBonus"
Enum: "nmId" "dtBonus" "bonusSumm"
Example: sort=nmId

Sorting:

  • nmId — by Wildberries item number
  • dtBonus — by fine date and time
  • bonusSumm — by fine amount
order
string
Default: "desc"
Enum: "desc" "asc"
Example: order=asc

Data order:

  • desc — descending
  • asc — ascending
limit
required
integer <= 1000
Example: limit=330

Number of retentions in the response

offset
integer
Default: 0
Example: offset=220

How many results to skip. For example, with value 10, the response will start with the 11 element

Responses

Response samples

Content type
application/json
{}

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 item price. Minimum deduction is 100,000 ₽, if the total item cost delivered to the pick-up point is more than 100,000 ₽ per one week.

Request limit per one seller account:
Type Period Limit Interval Burst
Personal 10 min 1 request 10 min 10 requests
Service 10 min 1 request 10 min 10 requests
Base with secret 10 min 1 request 10 min 10 requests
Base 1 h 1 request 1 h 1 request
Authorizations:
HeaderApiKey
query Parameters
date
string
Example: date=2023-12-01

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": [
    ]
}

Item Labeling{{ /api/v1/analytics/goods-labeling }}

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

Returns a report on deductions for the absence of mandatory item labeling.
The report contains photos of items where the labeling is absent or cannot be read.
Data can be obtained for up to 31 days, starting from March 2024

Request limit per one seller account:
Type Period Limit Interval Burst
Personal 1 min 1 request 1 min 10 requests
Service 1 min 1 request 1 min 10 requests
Base with secret 1 min 1 request 1 min 10 requests
Base 1 h 1 request 1 h 1 request
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": [
    ]
}

Share of Brand in Sales

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

Reports on the seller 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
  • Have inventory available, regardless of the warehouse
Request limit per one seller account:
Type Period Limit Interval Burst
Personal 1 min 1 request 1 min 10 requests
Service 1 min 1 request 1 min 10 requests
Base with secret 1 min 1 request 1 min 10 requests
Base 1 h 1 request 1 h 1 request
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.

Request limit per one seller account:
Type Period Limit Interval Burst
Personal 5 s 1 request 5 s 20 requests
Service 5 s 1 request 5 s 20 requests
Base with secret 5 s 1 request 5 s 20 requests
Base 1 h 1 request 1 h 1 request
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
Example: dateFrom=2025-02-28

Report period start, YYYY-MM-DD

dateTo
required
string
Example: dateTo=2025-03-21

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.

Request limit per one seller account:
Type Period Limit Interval Burst
Personal 5 s 1 request 5 s 20 requests
Service 5 s 1 request 5 s 20 requests
Base with secret 5 s 1 request 5 s 20 requests
Base 1 h 1 request 1 h 1 request
Authorizations:
HeaderApiKey
query Parameters
parentId
required
integer
Example: parentId=1

Parent category ID

brand
required
string
Example: brand=H%26M

Brand

dateFrom
required
string
Example: dateFrom=2025-02-28

Report period start, YYYY-MM-DD

dateTo
required
string
Example: dateTo=2025-03-21

Report period end, YYYY-MM-DD

Responses

Response samples

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

Blocked Items

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

Get Report{{ /api/v1/analytics/banned-products/blocked }}

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

Returns the list of blocked listings.

Request limit per one seller account:
Type Period Limit Interval Burst
Personal 10 s 1 request 10 s 6 requests
Service 10 s 1 request 10 s 6 requests
Base with secret 10 s 1 request 10 s 6 requests
Base 1 h 1 request 1 h 1 request
Authorizations:
HeaderApiKey
query Parameters
sort
required
string
Enum: "brand" "nmId" "title" "vendorCode" "reason"
Example: sort=nmId

Sorting

  • brand — by brand
  • nmId — by WB item number
  • title — by item title
  • vendorCode — by seller item number
  • 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": [
    ]
}

Returns and Item Movement Report

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

Get Report{{ /api/v1/analytics/goods-return }}

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

Returns a list of item returns to the seller. With one request, you can obtain a report for a maximum of 31 days.

Request limit per one seller account:
Type Period Limit Interval Burst
Personal 1 min 1 request 1 min 10 requests
Service 1 min 1 request 1 min 10 requests
Base with secret 1 min 1 request 1 min 10 requests
Base 1 h 2 requests 30 min 1 request
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": [
    ]
}