Общее (general)

Описание API, процедуры авторизации и доступ к новостям портала продавцов

Общее

Описание API, процедуры авторизации и доступ к новостям портала продавцов

Введение

Wildberries API предоставляет продавцам возможность управления магазином и получения оперативной и статистической информации по протоколу HTTP Rest API. Описание API предоставляется в формате Swagger (Open API) и может быть использовано для импорта в другие инструменты (такие как PostMan) или генерации клиентского кода на различных языках программирования с помощью Swagger CodeGen. Для ручной проверки API вы можете использовать:

  • Под ОС Windows - PostMan
  • Под ОС Linux - curl

Поддержка

Техническая поддержка осуществляется через диалоги в личном кабинете продавца. При создании нового обращения в техподдержку используйте категорию API. Новости и изменения, касающиеся API, публикуются в новостной ленте Wildberries и Telegram-канале.

Авторизация

Чтобы авторизоваться в API, вам понадобится токен. Он действует 180 дней после создания. Добавляйте токен в заголовок запроса Authorization.

По пункту 9.7.6 оферты запрещена интеграция с порталом продавца без публичного (этого) API.

Как создать токен

  1. В личном кабинете нажмите на имя профиля и выберите Настройки → Доступ к API.
  2. Если нужно, выберите опцию:
    • Тестовый контур: с токеном можно работать только в тестовом контуре (песочнице).
    • Только на чтение: с токеном нельзя ничего изменять, только получать данные. Работает для реальных данных и в тестовом контуре.
  3. Выберите, с какими категориями API вы будете работать с этим токеном.
Категория Методы
Контент Категории, предметы и характеристики
Карточки товаров
Номенклатуры
Теги
Аналитика Воронка продаж
Воронка продаж (Джем)
Поисковые запросы
Отчёт по остаткам на складах
Отчёты по удержаниям
Платная приёмка
Платное хранение
Продажи по регионам
Доля бренда в продажах
Скрытые товары
Отчёт по возвратам товаров
Цены и скидки Цены и скидки
Календарь акций
Маркетплейс Заказы FBS
Остатки
Статистика Отчеты по товарам
Финансовые отчёты
Продвижение Кампании
Создание кампаний
Управление кампаниями
Финансы
Параметры кампаний
Медиа
Статистика по продвижению
Вопросы и отзывы Вопросы
Отзывы
Шаблоны ответов
Аналитика по вопросам
Аналитика по отзывам
Чат с покупателями Чат с покупателями
Поставки Поставки FBW
Возвраты покупателями Возвраты покупателями
Документы Документы
Тарифы Тарифы
Выбирайте только те категории, с которыми вы планируете работать. Например, если вы будете только загружать карточки товаров, выберите одну категорию — Контент. Если токен попадёт в чужие руки, по нему нельзя будет получить доступ к другим категориям API вашего магазина.
  1. Нажмите Создать токен.
  2. Скопируйте и сохраните токен в безопасном месте. Потом его нельзя будет посмотреть в личном кабинете. Если вы потеряли токен, создайте новый.
Если у вас несколько сервисов (интеграций) для работы с разными категориями, создайте для них отдельные токены. Это позволит предоставить доступ только к необходимым категориям, а также более гибко и безопасно управлять интеграциями.

Как устроен токен

Токен представляет собой JWT согласно RFC 7519. Чтобы проверить, действителен ли ваш токен и какие категории методов API по нему доступны, вы можете декодировать его.

Рекомендуем не просматривать токен с помощью онлайн-инструментов, чтобы он не попал в чужие руки.

Публичные поля токена

Поля, которых нет в таблице, служебные, и могут быть удалены.

Поле Тип Описание
id UUIDv4 Уникальный ID токена
s uint Битовая маска свойств токена
sid UUIDv4 Уникальный ID продавца на Wildberries, которому принадлежит токен
exp uint Время жизни токена. Соответствует стандарту RFC 7519: JSON Web Token (JWT)
t boolean Тестовый контур (песочница)

Поле s

Поле s — это битовая маска, то есть целое число, каждый бит которого означает наличие или отсутствие какого-то свойства.

Подробнее про битовую маску

Значения бит

Позиция бита отсчитывается от 0, где 0 — это младший бит.

Позиция бита Свойство (если бит равен 1)
1 Доступ к категории Контент
2 Доступ к категории Аналитика
3 Доступ к категории Цены и скидки
4 Доступ к категории Маркетплейс
5 Доступ к категории Статистика
6 Доступ к категории Продвижение
7 Доступ к категории Вопросы и отзывы
9 Доступ к категории Чат с покупателями
10 Доступ к категории Поставки
11 Доступ к категории Возвраты покупателями
12 Доступ к категории Документы
30 Токен только на чтение

Проверка подключения к WB API

Проверка подключения{{ /ping }}

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

Проверяет:

  1. Успешно ли запрос доходит до WB API
  2. Валидность токена авторизации и URL запроса
  3. Совпадают ли категория токена и сервис
Метод не предназначен для проверки доступности сервисов WB
Категория URL запроса
Контент https://content-api.wildberries.ru/ping
https://content-api-sandbox.wildberries.ru/ping
Аналитика https://seller-analytics-api.wildberries.ru/ping
Цены и скидки https://discounts-prices-api.wildberries.ru/ping
https://discounts-prices-api-sandbox.wildberries.ru/ping
Маркетплейс https://marketplace-api.wildberries.ru/ping
Статистика https://statistics-api.wildberries.ru/ping
https://statistics-api-sandbox.wildberries.ru/ping
Продвижение https://advert-api.wildberries.ru/ping
https://advert-api-sandbox.wildberries.ru/ping
Вопросы и отзывы https://feedbacks-api.wildberries.ru/ping
https://feedbacks-api-sandbox.wildberries.ru/ping
Чат с покупателями https://buyer-chat-api.wildberries.ru/ping
Поставки https://supplies-api.wildberries.ru/ping
Возвраты покупателями https://returns-api.wildberries.ru/ping
Документы https://documents-api.wildberries.ru/ping
Тарифы, Новости 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"
}

API новостей

Получение новостей портала продавцов{{ /api/communications/v1/news }}

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

Метод позволяет получать новости с портала продавцов в формате HTML.
Для авторизации подходит любой скоуп токена - Контент, Статистика, Маркетплейс и др.
Для получения успешного ответа необходимо указать один из параметров from или fromID
За один запрос можно получить не более 100 новостей.

Максимум 10 запросов в 10 минут на один аккаунт продавца
Authorizations:
HeaderApiKey
query Parameters
from
string <date>
Example: from=2021-11-20

Дата, от которой необходимо выдать новости

fromID
integer <uint64>
Example: fromID=1885

ID новости, от которой необходимо выдать новости

Responses

Response samples

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