Как пользоваться документацией WB API

Навигация по методам, параметры, примеры и советы по эффективной работе

content

Где найти документацию

Документация WB API доступна на портале разработчиков по адресу dev.wildberries.ru — раздел «Документация» в верхнем меню. Она разделена по категориям API — каждая категория имеет свою страницу со всеми методами. Общий обзор возможностей портала — в статье «Обзор портала разработчиков WB API».


Категории документации

В боковом меню страницы документации расположены 13 категорий API. Каждая категория — это отдельная страница с полным перечнем методов.

Категория в документацииЧто содержит
ОбщееАвторизация, коды ошибок, лимиты запросов, проверка подключения, управление пользователями
Работа с товарамиСоздание и редактирование карточек товаров, медиафайлы, теги
Заказы FBSЗаказы с хранением на складе Wildberries, сборочные задания
Заказы DBWЗаказы с доставкой со склада продавца курьерской службой Wildberries
Заказы DBSЗаказы с доставкой силами продавца
Заказы СамовывозЗаказы с самовывозом покупателем из точки продавца
Поставки FBWПоставки на склад Wildberries, управление складами
Маркетинг и продвижениеРекламные кампании, ставки, статистика продвижения
Общение с покупателямиВопросы, отзывы, чат с покупателями
ТарифыКомиссии, тарифы на логистику
Аналитика и данныеАналитика продаж, отчёты по воронке, поисковые запросы
ОтчётыОтчёт о продажах по реализации, детализация
Документы и бухгалтерияФинансовые документы, акты, счета-фактуры

Подробнее о том, какие задачи решает каждая категория — в статье «Категории WB API».


Как найти нужный метод

Если вы знаете, какую задачу хотите решить, но не знаете, какой метод использовать:

1. Определите категорию. Подумайте, к какой области относится ваша задача. Например, если нужно обновить цены — это «Работа с товарами», а если посмотреть статистику продаж — «Аналитика и данные».

2. Откройте категорию в боковом меню. Нажмите на название категории — она раскроется, и вы увидите тематические блоки с методами.

3. Используйте поиск. В верхней части бокового меню есть поле «Поиск» — введите ключевое слово (например, «цена», «карточка», «заказ»), и документация покажет подходящие методы.

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


Как устроена страница документации

Каждая страница категории состоит из нескольких элементов.

Боковое меню (слева) — навигация по всем методам категории, сгруппированным по тематическим блокам. Нажмите на название метода, чтобы перейти к его описанию.

Описание категории (вверху) — в начале страницы кратко объясняется, какие задачи решают методы этой категории и какой тип токена нужен для доступа.

Описание метода (основная область) — подробная информация о выбранном методе: параметры, примеры запросов и ответов, коды ошибок.


Как читать описание метода

Каждый метод в документации описан по единому шаблону. Разберём основные элементы.

Заголовок и HTTP-метод

В заголовке указан HTTP-метод (GET, POST, PUT, DELETE, PATCH) и путь эндпоинта. Например:

POST /content/v2/cards/upload

Это значит: отправьте POST-запрос на указанный путь, используя домен категории «Работа с товарами» (content-api.wildberries.ru).

Категория токена

В начале каждой секции методов указано, какой токен нужен для доступа. Например: «Для доступа к методам используйте токен для категории Контент». Это значит, что при создании токена нужно было выбрать категорию данных «Контент».

Подробнее о категориях токенов — в статье «Категории данных WB API».

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

Для каждого метода или группы методов указаны ограничения на количество запросов — в виде таблицы с разбивкой по типам токенов. Формат:

ПараметрПримерЧто означает
Период1 минутаВременной интервал
Лимит300 запросовМаксимум запросов за период
Интервал200 мсРекомендуемая пауза между запросами
Всплеск (burst)20 запросовМаксимум запросов, которые можно отправить одновременно без пауз

Для Базовых и Тестовых токенов лимиты могут быть ниже, чем для Персональных и Сервисных. Подробнее о системе лимитов и алгоритме Token Bucket — в статье «Лимиты запросов WB API».

Параметры запроса

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

Примеры запроса и ответа

Готовые примеры в формате JSON, которые можно скопировать и адаптировать под свои нужды. Примеры — один из самых полезных элементов документации для быстрого старта.

Коды ответов

Список возможных кодов ответа с описанием: что означает каждый код и как действовать при ошибке. Полный справочник кодов — в статье «Расшифровка кодов ошибок WB API».


Как тестировать запросы через документацию

Документация WB API представлена в формате Swagger (OpenAPI), что позволяет отправлять тестовые запросы прямо из браузера.

Подробнее о работе со Swagger — в статье «Swagger: интерактивная документация WB API»

Для тестирования в безопасной среде используйте тестовый токен и песочницу (sandbox) — отдельный контур с искусственными данными, где невозможно повлиять на реальный магазин.

Подробнее — в статье «Тестовый токен и Песочница WB API»


Советы по эффективной работе с документацией

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

Обращайте внимание на ссылки «инструкция». В описаниях секций документации встречаются блоки: «Узнать, как использовать методы в бизнес-кейсах, можно в инструкции по...» — это ссылки на гайды с пошаговыми сценариями использования API.

Проверяйте журнал изменений. Если ваша интеграция перестала работать, первым делом проверьте Журнал изменений — возможно, метод был обновлён или заменён.

Используйте метод /ping для диагностики. Если запросы возвращают ошибки, начните с проверки подключения через метод /ping для нужной категории. Это поможет отделить проблемы с токеном от проблем с конкретным методом.

Сверяйтесь с гайдами. Если вы впервые работаете с категорией API — найдите соответствующий гайд в разделе «Гайды» Базы знаний. Гайды показывают методы в контексте реального сценария: в каком порядке вызывать, какие параметры передавать, какие ответы ожидать.