Поиск

Общее (general)

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

Общее

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

Введение

Wildberries API предоставляет продавцам возможность управления магазином и получения оперативной и статистической информации по протоколу HTTP Rest API.

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

Для ручной проверки API вы можете использовать:

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

Поддержка

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

Новости и изменения, касающиеся API, публикуются в новостной ленте Wildberries и Telegram-канале.

Статус-коды HTTP

Код Описание Как решить
200 Успешно
204 Удалено/Обновлено/Добавлено
400 Неправильный запрос Проверьте синтаксис запроса
401 Пользователь не авторизован Проверьте токен авторизации. Категория токена должна совпадать с категорией API. Также токен может:
• быть просроченным
• быть некорректным
• отсутствовать в запросе
403 Доступ запрещён Токен не должен быть сгенерирован удалённым пользователем. Доступ к методу не должен быть заблокирован. Если вы хотите использовать методы Джема, проверьте подписку в личном кабинете
404 Адрес не найден Проверьте URL запроса
409 Ошибка сохранения для части ссылок/обновления статуса/добавления сборочного задания/т.д. Проверьте данные запроса. Они должны отвечать требованиям и ограничениям сервиса
413 Превышен лимит объёма данных в запросе Уменьшите количество объектов в запросе
422 Отсутствие в запросе параметра nmId/Размер ставки не изменен/т.д. Проверьте данные запроса. Данные запроса не должны противоречить друг другу
429 Слишком много запросов Проверьте лимиты запросов и повторите запрос позже
5ХХ Внутренние ошибки сервиса Сервис недоступен. Повторите запрос позже или обратитесь в техническую поддержку

Лимиты запросов

В WB API есть ограничения на скорость отправки запросов. Для равномерного распределения нагрузки используется алгоритм token bucket. Лимиты для конкретных методов API указаны в документации.

Например:

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца

Это значит, что за минуту можно отправить 300 запросов. Эти запросы должны быть равномерно распределены по времени. То есть интервал между запросами должен составлять 60 секунд/300 запросов = 0.2 секунды.

API допускает всплески запросов — burst, когда можно одновременно выполнить несколько запросов. Допустимый всплеск возвращается в ответе в заголовке X-Ratelimit-Remaining. Он встречается во всех статусах ответов, кроме ошибки 429.

X-Ratelimit-Remaining — это количество запросов, которое можно выполнить на данный момент без добавления задержек. После каждого запроса значение X-Ratelimit-Remaining уменьшается на единицу. Если X-Ratelimit-Remaining равен 0 и следующий запрос вы сделали, не подождав, в ответ вы получите ошибку 429. Значение X-Ratelimit-Remaining восстанавливается со временем.

Есть случаи, когда один запрос может быть равен нескольким. Например, если вы отправляете запросы категории Маркетплейс, запрос с ошибкой 409 будет равен 5 запросам с другими статусами. Тогда значение X-Ratelimit-Remaining снизится сразу на 5 единиц.

Если вы превысите скорость выполнения запросов, вы получите ошибку 429. В этом случае следующий запрос вы сможете сделать только после небольшого ожидания. Чтобы понять, сколько времени вам нужно ждать, используйте заголовки ответа 429:

  • X-Ratelimit-Retry — через сколько секунд вы можете повторить запрос. Если вы сделаете попытку раньше, вы все равно будете получать ошибку 429.
  • X-Ratelimit-Limit — максимальное значение всплеска запросов — burst, которое будет восстановлено через X-Ratelimit-Reset секунд.
  • X-Ratelimit-Reset — через сколько секунд допустимый всплеск запросов восстановится до максимального значения, указанного в X-Ratelimit-Limit.

Пример ответа:

HTTP/1.1 429 Too Many Requests
...
X-Ratelimit-Reset: 29
X-Ratelimit-Retry: 2
...
X-Ratelimit-Limit: 10

Авторизация

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

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

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

  1. В личном кабинете нажмите на имя профиля и выберите Настройки → Доступ к API.
  2. Если нужно, выберите опцию:
    • Тестовый контур: с токеном можно работать только в тестовом контуре (песочнице).
    • Только на чтение: с токеном нельзя ничего изменять, только получать данные. Работает для реальных данных и в тестовом контуре.
  3. Выберите, с какими категориями API вы будете работать с этим токеном.
Категория Методы
Контент Категории, предметы и характеристики
Создание карточек товаров
Карточки товаров
Медиафайлы
Ярлыки
Аналитика Воронка продаж
Поисковые запросы
История остатков
Аналитика продавца CSV
Отчёт об остатках на складах
Отчёт о товарах с обязательной маркировкой
Отчёты об удержаниях
Платная приёмка
Платное хранение
Продажи по регионам
Доля бренда в продажах
Скрытые товары
Отчёт о возвратах товаров
Динамика оборачиваемости
Цены и скидки Цены и скидки
Календарь акций
Маркетплейс Заказы FBS
Склады продавца
Остатки
Заказы DBS
Самовывоз
Статистика Основные отчёты
Финансовые отчёты
Продвижение Кампании
Создание кампаний
Управление кампаниями
Финансы
Параметры кампаний
Медиа
Статистика по продвижению
Вопросы и отзывы Вопросы
Отзывы
Шаблоны ответов
Чат с покупателями Чат с покупателями
Поставки Поставки 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 Токен только на чтение

Декодирование токена

Декодирование токена позволяет проверить, является ли токен действительным и к каким категориям методов API имеется доступ. Вы можете декодировать токен на отдельной странице.

Проверка подключения к 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
Максимум 3 запроса за 30 секунд. Если попытаться автоматизировать использование метода, запросы будут временно заблокированы. Лимит действует отдельно для каждого варианта метода в зависимости от домена
Authorizations:
HeaderApiKey

Responses

Response samples

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

API новостей

Новости портала продавцов можно получить с любым токеном, у которого не выбрана опция Тестовый контур

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

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

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

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

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

fromID
integer <uint64>
Example: fromID=7369

ID новости, начиная с которой — включая её — нужно получить список новостей

Responses

Response samples

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

Информация о продавце

Получение информации о продавце{{ /api/v1/seller-info }}

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

Метод позволяет получать наименование продавца и ID его аккаунта.
В запросе можно использовать любой токен, у которого не выбрана опция Тестовый контур.

Максимум 1 запрос в минуту на один аккаунт продавца
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "name": "ИП Кружинин В. Р.",
  • "sid": "e8923014-e233-47q8-898e-3cc86d67ea61",
  • "tradeMark": "Flax Store"
}