General (general)
API description, authorization, seller portal news and seller information access
Wildberries API provides sellers with the opportunity to manage their store and receive operational and statistical information via the HTTP Rest API protocol.
API description is provided in the Swagger (Open API) format. It can be used for the import to the other tools (such as PostMan) or the client code generation on different programming languages with the help of Swagger CodeGen.
For manual API check you can use:
Technical support is provided through web chats in seller portal. When creating new support request, please select category from API group.
All news and changes regarding API are being published in Wildberries news and Telegram channel.
Code | Description | How to resolve |
---|---|---|
200 | Success | |
204 | Deleted/Updated/Confirmed | |
400 | Bad request | Check the request syntax |
401 | Unauthorized | Check the authorization token. The token category must match the API category. Additionally, the token may be: • expired • incorrect • missing from the request |
403 | Access denied | The token must not be generated by a deleted user. Access to the method must not be blocked. If you want to use the Jam methods, check your subscription in your personal account |
404 | Not found | Check the request URL |
409 | Status update error/Error adding label/etc | Check the request data. It must meet the service's requirements and limitations |
413 | The request body size exceeds the given limit | Reduce the number of objects in the request |
422 | Error processing request parameters/Unexpected result/etc | Check the request data. The request data must not contradict each other |
429 | Too many requests | Check the method rate limits and retry the request later |
5ХХ | Internal service error | Service is unavailable. Retry the request later or contact WB technical support |
The WB API has request rate limits. To evenly distribute the load, the token bucket
algorithm is used. Limits for specific API methods are specified in the documentation.
For example:
This means that you can send 300 requests per minute. These requests should be evenly distributed over time, meaning the interval between requests should be 60 seconds/300 requests = 0.2 seconds
.
The API allows for request bursts, where you can perform several requests simultaneously. The allowable burst is returned in the response header X-Ratelimit-Remaining
. It appears in all response statuses except for error 429
.
X-Ratelimit-Remaining
is the number of requests you can currently make without adding delays. After each request, the X-Ratelimit-Remaining
value decreases by one. If X-Ratelimit-Remaining
is 0 and you make the next request without delay, you will receive a 429
error in response. The X-Ratelimit-Remaining
value replenishes over time.
409
error will count as 5 requests with other statuses. In such cases, the value of X-Ratelimit-Remaining
will decrease by 5 units immediately.
If you exceed the request rate limit, you will receive a 429
error. In this case, you need to wait a short period before making the next request. To determine how long you need to wait, use the headers from the 429
response:
X-Ratelimit-Retry
— the number of seconds after which you can retry the request. If you attempt it earlier, you will continue to receive a429
error.X-Ratelimit-Limit
— the maximum allowable burst of requests, which will be replenished afterX-Ratelimit-Reset
seconds.X-Ratelimit-Reset
— the number of seconds after which the allowable burst of requests will be restored to the maximum value specified inX-Ratelimit-Limit
.
Response example:
HTTP/1.1 429 Too Many Requests
...
X-Ratelimit-Reset: 29
X-Ratelimit-Retry: 2
...
X-Ratelimit-Limit: 10
You need API token to authenticate requests. It is valid for 180 days after creation. Add the token to the Authorization
request header.
- Go to your seller account, click the profile name and select Settings → Access to API.
- If necessary, select the option:
- Test scope (Sandbox): the token can only be used in a test scope (sandbox).
- Read only: You can't change any data using this token, it's only for reading. The token can be used with real data and in the test scope (sandbox).
- Choose the API categories for this token.
Category | Methods |
---|---|
Content | Categories, Subjects and Characteristics Products Cards Nomenclatures Tags |
Analytics | Sales Funnel Search Queries Seller Analytics CSV Stocks Report Seller Analytics CSV Warehouses Remains Report Retention Reports Paid Reception Paid Storage Sales by Regions Share of Brand in Sales Hidden Products Goods Return Report Turnover Dynamics |
Prices and Discounts | Prices and Discounts Promotions Calendar |
Marketplace | FBS Orders Seller Warehouses Inventory DBS Orders In-Store Pickup |
Statistics | Product Reports Financial Reports |
Promotion | Campaigns Campaigns Creation Campaigns Management Finances Campaigns Parameters Media Promotion Statistics |
Feedbacks and Questions | Questions Feedbacks Response Templates |
Buyers Chat | Buyers Chat |
Supplies | FBW Supplies |
Buyers Returns | Buyers Returns |
Documents | Documents |
Tariffs | Tariffs |
- Click Create a token.
- Copy and save the token in some safe place. Later you can't view it in your seller account. If you lost your token, create a new one.
The token is a JWT according to RFC 7519. To check if your token is valid and which categories of API methods are available with it, you can decode it.
Public token fields
Fields that are not in the table are service fields and can be deleted.
Field | Type | Description |
---|---|---|
id |
UUIDv4 |
Unique token ID |
s |
`uint` |
Token properties bitmask |
sid |
`UUIDv4' |
Wildberries seller ID |
exp |
`uint` |
Token lifetime, complies with RFC 7519: JSON Web Token (JWT) |
t |
boolean |
Test scope (sandbox) |
s
field
The s
field is a bitmask, an integer, each bit of which means the presence or absence of some option.
Learn more about bitmask
Bit values
Bit position | Property (if bit is 1) |
---|---|
1 | Access to Content |
2 | Access to Analytics |
3 | Access to Prices and discounts |
4 | Access to Marketplace |
5 | Access to Statistics |
6 | Access to Promotion |
7 | Access to Feedbacks and Questions |
9 | Access to Buyers chat |
10 | Access to Supplies |
11 | Access to Buyers returns |
12 | Access to Documents |
30 | Read only token |
Token decoding will allow to check if the token is valid and which categories of API methods are available. You can decode the token on the separate page.
Connection Check{{ /ping }}
Checks:
- Whether the request successfully reaches the WB API.
- The validity of the authorization token and request URL.
- Whether the token category matches the service.
Each service has its own version of the method depending on the domain:
Category | Request URL |
---|---|
Content | https://content-api.wildberries.ru/ping https://content-api-sandbox.wildberries.ru/ping |
Analytics | https://seller-analytics-api.wildberries.ru/ping |
Prices and Discounts | https://discounts-prices-api.wildberries.ru/ping https://discounts-prices-api-sandbox.wildberries.ru/ping |
Marketplace | https://marketplace-api.wildberries.ru/ping |
Statistics | https://statistics-api.wildberries.ru/ping https://statistics-api-sandbox.wildberries.ru/ping |
Promotion | https://advert-api.wildberries.ru/ping https://advert-api-sandbox.wildberries.ru/ping |
Feedbacks and Questions | https://feedbacks-api.wildberries.ru/ping https://feedbacks-api-sandbox.wildberries.ru/ping |
Buyers Chat | https://buyer-chat-api.wildberries.ru/ping |
Supplies | https://supplies-api.wildberries.ru/ping |
Buyers Returns | https://returns-api.wildberries.ru/ping |
Documents | https://documents-api.wildberries.ru/ping |
Tariffs, News | https://common-api.wildberries.ru/ping |
Authorizations:
Responses
Response samples
- 200
- 401
- 429
{- "TS": "2024-08-16T11:19:05+03:00",
- "Status": "OK"
}
Getting seller portal news{{ /api/communications/v2/news }}
The method allows getting news from the seller portal in HTML format.
To receive a successful response, one of the parameters from
or fromID
must be specified.
You can get up to 100 news items per request.
Authorizations:
query Parameters
from | string <date> Example: from=2025-02-06 Date from which to get news |
fromID | integer <uint64> Example: fromID=7369 The news ID, starting from which — including it — you need to get the list of news |
Responses
Response samples
- 200
- 401
- 429
{- "data": [
- {
- "content": "Теперь в кампаниях ВБ.Медиа вы можете размещать баннеры для пользователей, которые взаимодействовали с товарами из определённой категории: покупали, искали, добавляли в корзину и избранное. Также можно выбрать период, за который хотите учитывать эти действия.Например, вы продаёте обувь. Рекламу можно показать людям, которые добавляли в корзину или избранное товары из этой категории за последние 14 дней. Возможно, пользователи, которые попадают под этот критерий, уже совершили покупку. Поэтому вы можете уточнить настройки показа: добавить параметр «Не покупал товар из категории „Обувь“ в последние 14 дней». Так вероятность того, что ваш баннер приведёт к покупке, будет выше.Чтобы запустить рекламу, создайте в кабинете ВБ.Медиа кампанию «По показам» и на шаге 4 включите «Поведенческие параметры». Эти параметры можно комбинировать с таргетированием по предполагаемым интересам, полу, возрасту и региону.Подробнее о том, как настроить таргетинг, — в инструкции «По показам».Запустить рекламу на Wildberries ",
- "date": "2025-02-05T14:10:35+03:00",
- "header": "Новые настройки кампаний в ВБ.Медиа: таргетируйте рекламу в зависимости от того, как аудитория использует сервисы Wildberries",
- "id": 7369,
- "types": [
- {
- "id": 4,
- "name": "Маркетинг"
}
]
}, - {
- "content": "Добавили получение отчётов по текстам поисковых запросов в формате CSV. В описания методов «Создать отчёт» и «Получить отчёт» добавили описания и примеры моделей: • запросов — SearchReportTextReq, • успешных ответов (статус-код 200) — SearchReportTextRes.В ответ метода «Поисковые запросы по товару» добавили 8 полей и структуры price и medianPosition. Узнать больше можно в Журнале изменений.Эти методы доступны только с подпиской «Джем»",
- "date": "2025-02-06T18:14:58+03:00",
- "header": "Изменения в API «Аналитики и данных»",
- "id": 7373,
- "types": [
- {
- "id": 8,
- "name": "API"
}, - {
- "id": 41,
- "name": "Аналитика продавца"
}
]
}
]
}
Get seller information{{ /api/v1/seller-info }}
This method allows you to obtain the seller's name and account ID.
You can use any token in request, as long as the Test Environment
option is not selected.
Authorizations:
Responses
Response samples
- 200
- 401
- 429
{- "name": "ИП Кружинин В. Р.",
- "sid": "e8923014-e233-47q8-898e-3cc86d67ea61",
- "tradeMark": "Flax Store"
}