Общее (general)
Описание API, процедуры авторизации, доступ к новостям портала продавцов и информации о продавцах
Описание API, процедуры авторизации, доступ к новостям портала продавцов и информации о продавцах
Wildberries API предоставляет продавцам возможность управления магазином и получения оперативной и статистической информации по протоколу HTTP Rest API.
Описание API предоставляется в формате Swagger (Open API) и может быть использовано для импорта в другие инструменты (такие как PostMan) или генерации клиентского кода на различных языках программирования с помощью Swagger CodeGen.
Для ручной проверки API вы можете использовать:
Техническая поддержка осуществляется через диалоги в личном кабинете продавца. При создании нового обращения в техподдержку используйте категорию API.
Новости и изменения, касающиеся API, публикуются в новостной ленте Wildberries и Telegram-канале.
Код | Описание | Как решить |
---|---|---|
200 | Успешно | |
204 | Удалено/Обновлено/Добавлено | |
400 | Неправильный запрос | Проверьте синтаксис запроса |
401 | Пользователь не авторизован | Проверьте токен авторизации. Категория токена должна совпадать с категорией API. Также токен может: • быть просроченным • быть некорректным • отсутствовать в запросе |
403 | Доступ запрещён | Токен не должен быть сгенерирован удалённым пользователем. Доступ к методу не должен быть заблокирован. Если вы хотите использовать методы Джема, проверьте подписку в личном кабинете |
404 | Адрес не найден | Проверьте URL запроса |
409 | Ошибка сохранения для части ссылок/обновления статуса/добавления сборочного задания/т.д. | Проверьте данные запроса. Они должны отвечать требованиям и ограничениям сервиса |
413 | Превышен лимит объёма данных в запросе | Уменьшите количество объектов в запросе |
422 | Отсутствие в запросе параметра nmId/Размер ставки не изменен/т.д. | Проверьте данные запроса. Данные запроса не должны противоречить друг другу |
429 | Слишком много запросов | Проверьте лимиты запросов и повторите запрос позже |
5ХХ | Внутренние ошибки сервиса | Сервис недоступен. Повторите запрос позже или обратитесь в техническую поддержку |
В WB API есть ограничения на скорость отправки запросов. Для равномерного распределения нагрузки используется алгоритм token bucket
. Лимиты для конкретных методов API указаны в документации.
Например:
Это значит, что за минуту можно отправить 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
.
- В личном кабинете нажмите на имя профиля и выберите Настройки → Доступ к API.
- Если нужно, выберите опцию:
- Тестовый контур: с токеном можно работать только в тестовом контуре (песочнице).
- Только на чтение: с токеном нельзя ничего изменять, только получать данные. Работает для реальных данных и в тестовом контуре.
- Выберите, с какими категориями API вы будете работать с этим токеном.
- Нажмите Создать токен.
- Скопируйте и сохраните токен в безопасном месте. Потом его нельзя будет посмотреть в личном кабинете. Если вы потеряли токен, создайте новый.
Токен представляет собой 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 имеется доступ. Вы можете декодировать токен на отдельной странице.
Проверка подключения{{ /ping }}
Метод проверяет:
- Успешно ли запрос доходит до WB API
- Валидность токена авторизации и URL запроса
- Совпадают ли категория токена и сервис
У каждого сервиса есть свой вариант метода в зависимости от домена:
Категория | 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:
Responses
Response samples
- 200
- 401
- 429
{- "TS": "2024-08-16T11:19:05+03:00",
- "Status": "OK"
}
Получение новостей портала продавцов{{ /api/communications/v2/news }}
Метод позволяет получать новости портала продавцов.
Для получения успешного ответа необходимо указать один из параметров from
или fromID
.
За один запрос можно получить не более 100 новостей.
Authorizations:
query Parameters
from | string <date> Example: from=2025-02-06 Дата, от которой необходимо выдать новости |
fromID | integer <uint64> Example: fromID=7369 ID новости, начиная с которой — включая её — нужно получить список новостей |
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": "Аналитика продавца"
}
]
}
]
}
Получение информации о продавце{{ /api/v1/seller-info }}
Метод позволяет получать наименование продавца и ID его аккаунта.
В запросе можно использовать любой токен, у которого не выбрана опция Тестовый контур
.
Authorizations:
Responses
Response samples
- 200
- 401
- 429
{- "name": "ИП Кружинин В. Р.",
- "sid": "e8923014-e233-47q8-898e-3cc86d67ea61",
- "tradeMark": "Flax Store"
}