API docs by Redocly

Seller API Analytics

The service provides a public API for obtaining analytical data. With these methods, you can get analytical reports.

Sales Funnel

Time Zones

IANA format, the current list can be viewed here.

Retrieving product card (PC) statistics for a selected period, based on nmID/items/brands/labels

Retrieving statistics for product cards (PC) for a selected period, based on nmID/items/brands/labels.
The fields brandNames, objectIDs, tagIDs, nmIDs can be empty, in which case statistics for all product cards from the seller are included in the response.
When multiple fields are selected, the response includes data for cards that have all the selected fields. Pagination is supported. You can obtain a report for a maximum of one last year (365 days).

Also, in the data where information about the previous period is provided:

  • In previousPeriod, the data is for the same period as in selectedPeriod.
  • If the start date of previousPeriod is earlier than a year ago from the current date, it will be adjusted as follows: previousPeriod.start = current date - 365 days.


3 requests per minute are allowed.

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

Brand name

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

Item ID

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

Numeric label ID

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

WB article

timezone
string

Timezone.
If not specified, the default is Europe/Moscow

required
object

Period

object

Sorting Parameters. If not specified, the default is "openCard" with descending order.

All sorting options field:
openCard — by card opening (transition to the product page)
addToCart — by additions to the cart
orders — by the number of orders
avgRubPrice — by average price in rubles
ordersSumRub — by the total order amount in rubles
stockMpQty — by the quantity of marketplace stock (pieces)
stockWbQty — by the quantity of warehouse stock (pieces)
cancelSumRub — by the sum of returns in rubles
cancelCount — by the number of returns
buyoutCount — by the number of buyouts
buyoutSumRub — by the total buyout amount in rubles

page
required
integer <int32>

Page

Responses

Response Schema: application/json
object
error
boolean

Error flag

errorText
string

Error description

Array of objects

Additional errors

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

Retrieving product card statistics for a period, grouped by items, brands, and labels

Retrieving statistics for product cards for a period, grouped by items, brands, and labels.
The fields brandNames, objectIDs, tagIDs can be left empty, in which case grouping is done for all product cards from the seller. You can obtain a report for a maximum of one last year (365 days).

Also, in the data where information about the previous period is provided:

  • In previousPeriod, the data is for the same period as in selectedPeriod.
  • If the start date of previousPeriod is earlier than a year ago from the current date, it will be adjusted as follows: previousPeriod.start = current date - 365 days.


3 requests per minute are allowed.

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

Item ID

brandNames
Array of strings

Brand name

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

Numeric label ID

timezone
string

Timezone.
If not specified, the default is Europe/Moscow

required
object

Period

object

Sorting Parameters. If not specified, the default is "openCard" with descending order.

All sorting options field:
openCard — by card opening (transition to the product page)
addToCart — by additions to the cart
orders — by the number of orders
avgRubPrice — by average price in rubles
ordersSumRub — by the total order amount in rubles
stockMpQty — by the quantity of marketplace stock (pieces)
stockWbQty — by the quantity of warehouse stock (pieces)
cancelSumRub — by the sum of returns in rubles
cancelCount — by the number of returns
buyoutCount — by the number of buyouts
buyoutSumRub — by the total buyout amount in rubles

page
required
integer <int32>

Page

Responses

Response Schema: application/json
object
error
boolean

Error flag

errorText
string

Error description

Array of objects

Additional errors

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

Retrieving product card statistics by days for selected nmID(s)

Retrieving product card statistics by days for selected nmID(s). You can obtain a report for a maximum of one last week. To obtain reports for a period of up to one year, subscribe to Jam extended analytics.
3 requests per minute are allowed.

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

WB article (maximum 20)

required
object

Period

timezone
string

Timezone.
If not specified, the default is Europe/Moscow

aggregationLevel
string

Aggregation Type. If not specified, the default is aggregation by days.
Available aggregation levels: day, week, month

Responses

Response Schema: application/json
Array of objects
error
boolean

Error flag

errorText
string

Error description

Array of objects

Additional errors

Request samples

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

Response samples

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

Retrieving product card statistics by days for a period, grouped by items, brands, and labels

Retrieving product card statistics by days for a period, grouped by items, brands, and labels.
The fields brandNames, objectIDs, tagIDs can be left empty, in which case grouping is done for all seller's product cards.
In the request, the product, brand, and label count should not exceed 16. You can obtain a report for a maximum of one last week. To obtain reports for a period of up to one year, subscribe to Jam extended analytics.
3 requests per minute are allowed.

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

Item ID

brandNames
Array of strings

Brand name

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

Numeric label ID

required
object

Period

timezone
string

Timezone.
If not specified, the default is Europe/Moscow

aggregationLevel
string

Aggregation Type. If not specified, the default is aggregation

Responses

Response Schema: application/json
Array of objects
error
boolean

Error flag

errorText
string

Error description

Array of objects

Additional errors

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

Search Queries

These methods can be used to obtain a report on search queries.

You can use these methods only with Jam subscription

Main Page

Forms a dataset for the main report page with:

  • General information
  • Product positions
  • Data on visibility and transitions to the product card
  • Data for the table by groups

To obtain additional data in the table, use a separate request for:

  • Pagination by groups
  • Retrieval of products within a group

Additional parameters for selecting the list of products in the table:

  • positionCluster — average position in search

Maximum 3 requests per minute

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

Current period

object (pastPeriod)

Previous period for comparison. Number of days — less than or equal to currentPeriod

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

List of WB article numbers for filtering

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

List of subject IDs for filtering

brandNames
Array of strings

List of brands names for filtering

tagIds
Array of integers <int64> [ items <int64 > ]

List of label IDs for filtering

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

Which average search position of products to display in the report:

  • all — all
  • firstHundred — from 1 to 100
  • secondHundred — from 101 to 200
  • below — from 201 and below
required
object (OrderBy)

Soring parameters

limit
required
integer <uint32> <= 1000

Number of product groups in the response

offset
required
integer <uint32>

From which element to start outputting data

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": {
    }
}

Pagination by Groups

Pagination by groups in the report. It is possible only if there is a filter by brand, subject, or label.

Additional parameters for selecting the list of products in the table:

  • positionCluster — average position in search

Maximum 3 requests per minute

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

Current period

object (pastPeriod)

Previous period for comparison. Number of days — less than or equal to currentPeriod

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

List of WB article numbers for filtering

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

List of subject IDs for filtering

brandNames
Array of strings

List of brands names for filtering

tagIds
Array of integers <int64> [ items <int64 > ]

List of label IDs for filtering

required
object (OrderBy)

Soring parameters

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

Which average search position of products to display in the report:

  • all — all
  • firstHundred — from 1 to 100
  • secondHundred — from 101 to 200
  • below — from 201 and below
limit
required
integer <uint32> <= 1000

Number of product groups in the response

offset
required
integer <uint32>

From which element to start outputting data

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": {
    }
}

Pagination by Products Within a Group

Pagination by products within a group. It is possible regardless of the presence of filters.

Filters for pagination by products within a group or without filters:

  • tuple subjectId, brandName, tagId — filter for the group
  • nmIds — filter by nomenclature

Additional parameters for selecting the list of products in the table:

  • positionCluster — average position in search

Maximum 3 requests per minute

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

Current period

object (pastPeriod)

Previous period for comparison. Number of days — less than or equal to currentPeriod

subjectId
integer <int32>

Subject ID

brandName
string

Product name

tagId
integer <int64>

Label ID

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

WB article numbers list

required
object (OrderBy)

Soring parameters

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

Which average search position of products to display in the report:

  • all — all
  • firstHundred — from 1 to 100
  • secondHundred — from 101 to 200
  • below — from 201 and below
limit
required
integer <uint32> <= 1000

Number pf products in the response

offset
required
integer <uint32>

From which element to start outputting data

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": {
    }
}

Search Queries by Product

Forms the top search queries by product.

Search query selection parameters:

  • limit — number of queries, maximum 30
  • topOrderBy — method for selecting the top queries

Maximum 3 requests per minute

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

Current period

object (pastPeriod)

Previous period for comparison. Number of days — less than or equal to currentPeriod

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

WB article numbers list

topOrderBy
required
string
Enum: "openCard" "addToCart" "openToCart" "orders" "cartToOrder"

Sorting by field:

  • openCard — transitioned to the product card from search
  • addToCart — added to the cart from search
  • openToCart — conversion to cart from search
  • orders — ordered products from search
  • cartToOrder — conversion to order from search
required
object (OrderBy)

Soring parameters

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

Number of search queries for the product

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": {
    }
}

Orders and Positions by Product Search Queries

Forms data for a table on the number of orders and positions by queries. The data is specified within a period for a specific product

Maximum 3 requests per minute

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

Current period. Maximum 7 days

nmId
required
integer <uint64>

WB article

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

Search query

Responses

Response Schema: application/json
required
object

Request samples

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

Response samples

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

Seller Analytics CSV

You can use these methods only with Jam subscription.

To get a report:

  1. Generate it using the method Create the report.
  2. Wait until the report is ready. You can check the status with the method Get the reports list. The report is stored for 48 hours after it is ready, and it cannot be retrieved after.
    If you receive a status of FAILED, regenerate the report.
  3. Download the report.

You can obtain a report for a maximum of one year.

The maximum number of reports that can be generated per day is 20

Create the report

You can create a report on sales funnel or search parameters with grouping:

  • by WB articles;
  • by categories, brands, and labels.

In each of reports on sales funnel, you can group data by days, weeks, or months.


Maximum of 3 requests per minute is allowed, and maximum of 20 reports can be generated per day (only successful generations are counted).

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

Report ID in UUID format. Generated by the seller independently

reportType
required
string

Report type — DETAIL_HISTORY_REPORT

userReportName
string

Report name (if not specified, it will be generated automatically)

required
object

Report parameters

Responses

Response Schema: application/json
data
required
string

Notification that report generation has started.

Request samples

Content type
application/json
Example

Sales funnel report. By WB articles

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

Response samples

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

Get the reports list

Maximum of 3 requests per minute

Authorizations:
HeaderApiKey
query Parameters
filter[downloadIds]
Array of strings <uuid> [ items <uuid > ]

Report ID

Responses

Response Schema: application/json
required
Array of objects

Response samples

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

Regenerate the report

Maximum of 3 requests per minute

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
downloadId
string <uuid>

Report ID

Responses

Response Schema: application/json
data
required
string

Notification that report re-generation has started

Request samples

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

Response samples

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

Get the report

You can get a report that was generated within the last 48 hours.
The report will be downloaded inside a ZIP archive in CSV format.

Maximum of 3 requests per minute

Authorizations:
HeaderApiKey
path Parameters
downloadId
required
string <uuid>

Report ID

Responses

Response Schema: text/csv
string <binary>

Fields description in the CSV file:

Sales funnel report

Name Type Format Description
nmID (only DETAIL_HISTORY_REPORT) integer int32 WB article
dt string date Date
openCardCount integer int32 Product page views
addToCartCount integer int32 Added to cart, quantity
ordersCount integer int32 Ordered products, quantity
ordersSumRub integer int32 Ordered amount, ₽
buyoutsCount integer int32 Purchased products, quantity
buyoutsSumRub integer int32 Purchased amount, ₽
cancelCount integer int32 Cancelled products, quantity
cancelSumRub integer int32 Cancelled amount, ₽
addToCartConversion number int32 Cart conversion rate, % (Percentage of visitors who added the product to the cart after opening the product page)
cartToOrderConversion integer int32 Order conversion rate, % (Percentage of visitors who made an order after adding the product to the cart)
buyoutPercent integer int32 Purchase rate, % (Percentage of visitors who ordered the product and purchased it. Excluding products still being delivered to the buyer)

Search parameters report. By categories, brands, and labels

Name Type Format Description
SubjectName string string Subject name
SubjectID integer int32 Subject ID
BrandName string string Brand
TagID integer int64 Label ID
AveragePosition integer uint64 Average product position in search results in the current period
OpenCard integer uint64 Number of transitions to the product card from search in the current period
AddToCart integer uint64 How many times the product from search was added to the cart in the current period
OpenToCart integer uint64 Conversion to cart from search in the current period
Orders integer uint64 How many times products from search were ordered in the current period
CartToOrder integer uint64 Conversion to order from search in the current period
Visibility integer uint64 How many times the product card was displayed in search results in the current period
AveragePositionPast integer uint64 Average product position in search results in the past period (filled in if the previous period is specified)
OpenCardPast integer uint64 Number of transitions to the product card from search in the past period (filled in if the previous period is specified)
AddToCartPast integer uint64 How many times the product from search was added to the cart in the past period (filled in if the previous period is specified)
OpenToCartPast integer uint64 Conversion to cart from search in the past period filled in if the previous period is specified)
OrdersPast integer uint64 How many times products from search were ordered in the past period (filled in if the previous period is specified)
CartToOrderPast integer uint64 Conversion to order from search in the past period (filled in if the previous period is specified)
VisibilityPast integer uint64 How many times the product card was displayed in search results in the past period (filled in if the previous period is specified)

Search parameters report. By WB articles

Name Type Format Description
NmID integer int64 WB article
VendorCode string string Seller's article
Name string string Product name
SubjectName string string Subject name
BrandName string string Brand
IsAdvertised boolean bool Is the product being promoted
IsRated boolean bool Is there an opportunity to rate the product card quality
Rating float float64 Product card rating
FeedbackRating float float64 Feedbacks rating
MinPrice integer uint64 Minimal seller's price with seller's discount (excluding WB Club discount)
MaxPrice integer uint64 Maximal seller's price with seller's discount (excluding WB Club discount)
AveragePosition integer uint64 Average product position in search results in the current period
OpenCard integer uint64 Number of transitions to the product card from search in the current period
AddToCart integer uint64 How many times the product from search was added to the cart in the current period
OpenToCart integer uint64 Conversion to cart from search in the current period
Orders integer uint64 How many times products from search were ordered in the current period
CartToOrder integer uint64 Conversion to order from search in the current period
Visibility integer uint64 How many times the product card was displayed in search results in the current period
AveragePositionPast integer uint64 Average product position in search results in the past period (filled in if the previous period is specified)
OpenCardPast integer uint64 Number of transitions to the product card from search in the past period (filled in if the previous period is specified)
AddToCartPast integer uint64 How many times the product from search was added to the cart in the past period (filled in if the previous period is specified)
OpenToCartPast integer uint64 Conversion to cart from search in the past period (filled in if the previous period is specified)
OrdersPast integer uint64 How many times products from search were ordered in the past period (filled in if the previous period is specified)
CartToOrderPast integer uint64 Conversion to order from search in the past period (filled in if the previous period is specified)
VisibilityPast integer uint64 How many times the product card was displayed in search results in the past period (filled in if the previous period is specified)

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

Warehouses remains report

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

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 1 request per minute

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 Schema: application/json
object (CreateTaskResponseData)

Response samples

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

Check the status

Returns the status of the generation task. Maximum 1 request per 5 seconds

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

Generation task ID

Responses

Response Schema: application/json
object (GetTasksResponseData)

Response samples

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

Get the report

Returns the report by task ID.

Maximum 1 request per minute

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

Generation task ID

Responses

Response Schema: application/json
Array
brand
string

Brand

subjectName
string

Subject name

vendorCode
string

Seller's article

nmId
integer

WB article

barcode
string

Barcode

techSize
string

Size

volume
number

Volume, L

inWayToClient
integer

In transit to the client

inWayFromClient
integer

In transit from the client

quantityWarehousesFull
integer

Total stock across all warehouses, sum of quantity

Array of objects

Warehouses. A warehouse will be included in the response only if the stock is non-zero

Response samples

Content type
application/json
[
  • {
    }
]

Products with mandatory labeling

Report on products with mandatory labeling

Returns operations with labeled products. Maximum 10 requests per 5 hours.

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

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

Request samples

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

Response samples

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

Paid storage

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

Create a task to generate a report. Maximum report period — 8 days. Maximum 1 request per minute

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 Schema: application/json
object (CreateTaskResponseData)

Response samples

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

Check the status

Returns the status of task. Maximum 1 request per minute

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

Task ID

Responses

Response Schema: application/json
object (GetTasksResponseData)

Response samples

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

Get the report

Returns the report by task ID. Maximum 1 request per minute

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

Task ID

Responses

Response Schema: application/json
Array
date
string

Calculation or recalculation date

logWarehouseCoef
number

Logistics and storage coefficient

officeId
integer

Warehouse ID

warehouse
string

Warehouse name

warehouseCoef
number

Warehouse coefficient

giId
integer

Shipment ID

chrtId
integer

Size ID

size
string

Size (techSize in product card)

barcode
string

Barcode

subject
string

Subject (subcategory)

brand
string

Brand

vendorCode
string

Seller's article

nmId
integer

WB article

volume
number

Product volume

calcType
string

Calculation type

warehousePrice
number

Storage price

barcodesCount
integer

Chargeable product units in the warehouse, in the last 24 hours

palletPlaceCode
integer

Pallet place code

palletCount
number

Number of pallets

originalDate
string

Calculation date, in case of recalculation. If there was not a recalculation, the same as date

loyaltyDiscount
number

Loyalty program discount, ₽

tariffFixDate
string

Tariff fixing date

tariffLowerDate
string

Tariff reduction date

Response samples

Content type
application/json
[
  • {
    }
]

Paid receiving

Paid receiving report

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

Maximum 1 request per minute

Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string

Report period start, YYYY-MM-DD

dateTo
required
string

Report period end, YYYY-MM-DD

Responses

Response Schema: application/json
Array of objects

Response samples

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

Deductions

Self-purchases

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 10 requests per 100 minutes.

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 Schema: application/json
Array of objects

Response samples

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

Substitutions

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.

Maximum 1 request per minute.

Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string

Report period start, YYYY-MM-DD

dateTo
required
string

Report period end, YYYY-MM-DD

Responses

Response Schema: application/json
Array of objects

Response samples

Content type
application/json
{}

Logistics and storage factor

Returns logistics and storage factor. They are calculated weekly.

You can get data starting from 31.10.2022.

Maximum 1 request per minute.

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.

Authorizations:
HeaderApiKey
query Parameters
date
string

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

Responses

Response Schema: application/json
Array of objects

Response samples

Content type
application/json
{}

Product 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 10 requests per 10 minutes

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 Schema: application/json
Array of objects

Response samples

Content type
application/json
{}

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 10 requests per 10 minutes

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 Schema: application/json
Array of objects

Response samples

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

Sales by regions

Get report

Returns sales data grouped by regions of the countries. You can obtain a report for a maximum of 31 days.

Maximum 1 request in 10 seconds

Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string

Report period start, YYYY-MM-DD

dateTo
required
string

Report period end, YYYY-MM-DD

Responses

Response Schema: application/json
Array of objects

Response samples

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

Share of brand in sales

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

Returns the list of the seller brands.

You can only get brands that:

  • were sold in the last 90 days
  • are in WB stock

Maximum 1 request per minute

Authorizations:
HeaderApiKey

Responses

Response Schema: application/json
data
Array of strings

Brands list

Response samples

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

Parent categories of the brand

Returns parent categories of the brand.

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

Maximum 1 request per 5 seconds

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 Schema: application/json
Array of objects

Brand categories

Response samples

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

Get report

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 1 request per 5 seconds

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 Schema: application/json
Array of objects

Report

Response samples

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

Hidden products

Blocked product cards

Returns the list of blocked product cards

Maximum 1 request per 10 seconds

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 Schema: application/json
Array of objects

Report

Response samples

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

Hidden from the catalog

Returns the list of products hidden from the catalog

Maximum 1 request per 10 seconds

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 Schema: application/json
Array of objects

Report

Response samples

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

Goods return report

Get report

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

Maximum 1 request per minute

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 Schema: application/json
Array of objects

Report

Response samples

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