General (general)

API description, authorization and seller portal news access

General

API description, authorization and seller portal news access

Introduction

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:

Support

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.

Authorization

You need API token to authenticate requests. It is valid for 180 days after creation. Add the token to the Authorization request header.

According to clause 9.7.6 of the offer, integration with the seller portal without a public (this) API is prohibited.

How to create a token

  1. Go to your seller account, click the profile name and select Settings → Access to API.
  2. 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).
  3. Choose which API categories for this token.
Only select the categories you plan to work with. For example, if you will only upload product cards, select only Content category. If someone gets your token, they will not be able to gain access to the other API categories of your store.
Category Methods
Content Categories, Subjects and Characteristics
Products Cards
Nomenclatures
Tags
Analytics Sales Funnel
Sales Funnel (Jam)
Search phrases
Warehouses Remains Report
Retention Reports
Paid Reception
Paid Storage
Sales by Regions
Share of Brand in Sales
Hidden Products
Goods Return Report
Prices and Discounts Prices and Discounts
Promotions Calendar
Marketplace FBS Orders
Inventory
Statistics Product Reports
Financial Reports
Promotion Campaigns
Campaigns Creation
Campaigns Management
Finances
Campaigns Parameters
Media
Promotion Statistics
Feedbacks and Questions Questions
Reviews
Response Templates
Questions Analytics
Reviews Analytics
Buyers Chat Buyers Chat
Supplies FBW Supplies
Buyers Returns Buyers Returns
Documents Documents
Tariffs Tariffs
  1. Click Create a token.
  2. 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.
If you have several services (integrations) that work with different categories, create a token for each service. This will allow access to only the necessary categories, as well as more flexible and secure management of integrations.

About the token

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.

We recommend not to view the token using online tools so no one can take it over.

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 Questions and feedbacks
9 Access to Buyers chat
10 Access to Supplies
11 Access to Buyers returns
12 Access to Documents
30 Read only token

WB API Connection Check

Connection Check{{ /ping }}

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

Checks:

  1. Whether the request successfully reaches the WB API.
  2. The validity of the authorization token and request URL.
  3. Whether the token category matches the service.
This method is not intended to check the availability of WB services
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:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "TS": "2024-08-16T11:19:05+03:00",
  • "Status": "OK"
}

News API

Getting seller portal news{{ /api/communications/v1/news }}

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

The method allows getting news from the seller portal in HTML format.
Any token scope is suitable for authorization - Content, Statistics, Marketplace, etc.
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.

Maximum is 10 requests within 10 minutes
Authorizations:
HeaderApiKey
query Parameters
from
string <date>
Example: from=2021-11-20

Date from which to get news

fromID
integer <uint64>
Example: fromID=1885

News ID from which to get news

Responses

Response samples

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