Wildberries API TypeScript SDK

Full-featured TypeScript SDK providing type-safe access to all Wildberries marketplace API methods.

Полнофункциональный TypeScript SDK с полной типизацией для всех методов API маркетплейса Wildberries.

---

📚 Complete Documentation | Languages: English | Русский (Russian)

---

🌍 Language / Язык

• English Version - Full documentation in English
• Русская Версия - Полная документация на русском языке

---

English Version

Transform 11 OpenAPI specifications into a production-ready SDK with complete type safety, automatic rate limiting, retry mechanisms, and comprehensive error handling. Reduce integration time from weeks to hours.

✨ Features

• 🔐 Complete Type Safety - Auto-generated TypeScript types from OpenAPI specifications for all 11 API modules
• ⚡ Automatic Rate Limiting - Built-in enforcement of per-endpoint rate limits with intelligent queuing
• 🔄 Smart Retry Logic - Exponential backoff retry mechanism for transient failures
• 🛡️ Rich Error Handling - Typed error hierarchy with detailed recovery guidance
• 📦 Tree-Shakeable - Dual ESM/CommonJS builds, import only what you need (<100KB gzipped)
• ✅ Battle-Tested - 98% test coverage with 950+ tests across all modules
• 🎯 100% API Coverage - All 229 YAML endpoints implemented (v2.2.0)
• 📚 Comprehensive Documentation - Complete API reference, tutorials, and working examples in English and Russian
• 🔧 Zero Configuration - Works out of the box with sensible defaults, configurable for advanced use

⚠️ Critical API Update

Wildberries API Deprecation Notice - Four Promotion API methods will be disabled on February 2, 2026:

• getAutoGetnmtoadd() - List of Product Cards (type 8 campaigns)
• createAutoUpdatenm() - Update Product Cards (type 8 campaigns)
• getAutoStatWords() - Statistics by Phrase Clusters (type 8 campaigns)
• createAutoSetExcluded() - Set/Remove Minus-Phrases (type 8 campaigns)

Action Required: Migrate to type 9 campaign methods before February 2, 2026.

📖 Complete Migration Guide

---

📦 Installation

npm install daytona-wildberries-typescript-sdk

Requirements

• Node.js: ≥ 20.0.0
• TypeScript: ≥ 5.0.0 (for TypeScript projects)
• Wildberries API Key: Get one here

🚀 Quick Start

import { WildberriesSDK } from 'daytona-wildberries-typescript-sdk';

// Initialize SDK with your API key
const sdk = new WildberriesSDK({
  apiKey: process.env.WB_API_KEY! // Store securely in environment variables
});

// Test connectivity
const pingResponse = await sdk.general.ping();
console.log('Connected:', pingResponse.Status); // 'OK'

// Fetch product categories
const categories = await sdk.products.getParentAll();
console.log('Categories:', categories.data?.length);

// Get new orders
const orders = await sdk.ordersFBS.getOrdersNew();
console.log('New orders:', orders.orders?.length);

// Check account balance
const balance = await sdk.finances.getAccountBalance();
console.log('Balance:', balance.for_withdraw, balance.currency);

// Get advertising campaigns overview
const campaigns = await sdk.promotion.getPromotionCount();
console.log('Total campaigns:', campaigns.all);

// Get advertising balance
const advBalance = await sdk.promotion.getAdvBalance();
console.log('Ad cabinet balance:', advBalance.net);

// Get customer chat list with last messages (NEW in v2.3.2)
const chats = await sdk.communications.getSellerChats();
console.log('Active chats:', chats.result?.length);
chats.result?.forEach(chat => {
  if (chat.lastMessage) {
    console.log(`${chat.clientName}: "${chat.lastMessage.text}"`);
  }
});

Time to First API Call: <5 minutes 🚀

👉 Complete Quickstart Guide

---

📊 Project Status & Development

Current Status: 🟢 Production Ready | SDK Version: 1.0.0

📖 Project Status Summary — Comprehensive overview of all epics, stories, and implementation status.

Quick Stats

Metric	Value
API Modules	11/11 (100%)
API Endpoints	200+ implemented
Test Suite	5,219 tests passing (100%)
Quality Score	96.1/100
Documentation	73 files, 22 examples
Bundle Size	567KB gzipped

Epic Progress

• ✅ 5 epics completed (Foundation, Products/Orders, Extended Modules, Integration, Testing)
• 🔄 2 epics in progress (Documentation, Code Quality)
• 📝 3 epics planned (Documentation Site, Web API Module)

⚠️ For Contributors: When creating or completing epics/stories, update PROJECT_STATUS_SUMMARY.md to keep the project status current. This file is automatically generated and should reflect the latest implementation state.

---

📚 Documentation

Getting Started

• 5-Minute Quickstart - Get up and running
• Tutorials - Step-by-step guides
• API Reference - Complete TypeDoc documentation

Guides

• Best Practices - Production patterns
• Performance Tuning - Optimization guide
• Security - Secure integration
• Communications - Customer chat, Q&A, and reviews
• Promotion & Advertising - Campaign management
• Troubleshooting - Common issues

🎯 Supported API Modules

All 11 Wildberries API modules are fully supported with 100% API coverage:

Module	Description
General	Ping, news, seller info, connectivity testing
Products	Categories, CRUD, media, pricing, warehouse, stock
Orders FBS	Seller fulfillment, order status, shipping, supplies
Orders FBW	WB warehouse fulfillment, supply planning
Finances	Balance, transactions, reports, payouts
Analytics	Sales funnel, search queries, stock history, CSV reports
Reports	Income reports, sales reports, data exports
Communications	Customer chat with real-time messaging, product Q&A, reviews and ratings management, chat previews with last messages, NEW: pinned reviews for product cards
Promotion	Campaigns, promo codes, advertising ⚠️ Migration Required - 4 methods deprecated (Feb 2, 2026)
Tariffs	Commission rates, fee schedules
In-Store Pickup	Pickup point orders and management
Orders DBS	Delivery by Seller orders - seller handles storage AND delivery directly to customers, B2B support, product marking (SGTIN, IMEI)

📄 License

Personal Use License - Free for personal, educational, and non-commercial use.

✅ Permitted:

• Personal non-commercial use
• Educational purposes
• Open source projects (non-commercial)
• Learning and skill development

❌ Not Permitted Without Commercial License:

• Commercial use in business environments
• Selling or monetizing the SDK
• Providing paid services based on the SDK
• Use in commercial products/services

For commercial use, please contact for licensing.

See LICENSE file for complete terms.

🤝 Contributing

We welcome contributions! Whether it's bug reports, feature requests, documentation improvements, or code contributions.

→ Contributing Guide

📞 Support

• 📖 Documentation: https://salacoste.github.io/daytona-wildberries-typescript-sdk/
• ❓ FAQ: English | Русский
• 🐛 Bug Reports: Open an issue
• 💬 Discussions: GitHub Discussions

⚠️ Disclaimer

This is an unofficial SDK. It is not affiliated with, officially maintained by, or endorsed by Wildberries. Use at your own risk. Always refer to the official Wildberries API documentation for authoritative information.

---

Русская Версия

Преобразуйте 11 OpenAPI спецификаций в production-готовый SDK с полной типобезопасностью, автоматическими лимитами запросов, механизмами повторных попыток и комплексной обработкой ошибок. Сократите время интеграции с недель до часов.

✨ Возможности

• 🔐 Полная Типобезопасность - Автоматически генерируемые TypeScript типы из OpenAPI для всех 11 модулей
• ⚡ Автоматические Лимиты Запросов - Встроенное соблюдение лимитов для каждой конечной точки с умной очередью
• 🔄 Умная Логика Повторов - Экспоненциальная задержка для временных сбоев
• 🛡️ Богатая Обработка Ошибок - Типизированная иерархия ошибок с подробными рекомендациями
• 📦 Tree-Shakeable - Двойная сборка ESM/CommonJS, импортируйте только то, что нужно (<100KB gzip)
• ✅ Проверено в Бою - 98% покрытие тестами, 950+ тестов для всех модулей
• 🎯 100% Покрытие API - Все 229 эндпоинтов YAML реализованы (v2.2.0)
• 📚 Полная Документация - Справочник API, учебные руководства и примеры на английском и русском
• 🔧 Без Настройки - Работает из коробки с разумными значениями по умолчанию

⚠️ Критическое Обновление API

Уведомление об устаревании API Wildberries - Четыре метода Promotion API будут отключены 2 февраля 2026:

• getAutoGetnmtoadd() - Список карточек товаров (кампании type 8)
• createAutoUpdatenm() - Обновление карточек товаров (кампании type 8)
• getAutoStatWords() - Статистика по кластерам фраз (кампании type 8)
• createAutoSetExcluded() - Установка/удаление минус-фраз (кампании type 8)

Требуется действие: Перейдите на методы кампаний type 9 до 2 февраля 2026.

📖 Полное Руководство по Миграции

---

📦 Установка

npm install daytona-wildberries-typescript-sdk

Требования

• Node.js: ≥ 20.0.0
• TypeScript: ≥ 5.0.0 (для TypeScript проектов)
• API ключ Wildberries: Получить здесь

🚀 Быстрый Старт

import { WildberriesSDK } from 'daytona-wildberries-typescript-sdk';

// Инициализация SDK с вашим API ключом
const sdk = new WildberriesSDK({
  apiKey: process.env.WB_API_KEY! // Храните безопасно в переменных окружения
});

// Проверка подключения
const pingResponse = await sdk.general.ping();
console.log('Подключено:', pingResponse.Status); // 'OK'

// Получение категорий товаров
const categories = await sdk.products.getParentAll();
console.log('Категории:', categories.data?.length);

// Получение новых заказов
const orders = await sdk.ordersFBS.getOrdersNew();
console.log('Новые заказы:', orders.orders?.length);

// Проверка баланса счета
const balance = await sdk.finances.getAccountBalance();
console.log('Баланс:', balance.for_withdraw, balance.currency);

// Обзор рекламных кампаний
const campaigns = await sdk.promotion.getPromotionCount();
console.log('Всего кампаний:', campaigns.all);

// Баланс рекламного кабинета
const advBalance = await sdk.promotion.getAdvBalance();
console.log('Баланс рекл. кабинета:', advBalance.net);

// Список чатов с клиентами и последними сообщениями (НОВОЕ в v2.3.2)
const chats = await sdk.communications.getSellerChats();
console.log('Активные чаты:', chats.result?.length);
chats.result?.forEach(chat => {
  if (chat.lastMessage) {
    console.log(`${chat.clientName}: "${chat.lastMessage.text}"`);
  }
});

Время до первого API вызова: <5 минут 🚀

👉 Полное Руководство по Быстрому Старту

---

📊 Статус Проекта и Разработка

Текущий Статус: 🟢 Production Ready | Версия SDK: 1.0.0

📖 Project Status Summary — Комплексный обзор всех эпиков, историй и статуса реализации.

Краткая Статистика

Метрика	Значение
API модули	11/11 (100%)
API эндпоинты	200+ реализовано
Тесты	5,219 тестов проходят (100%)
Оценка качества	96.1/100
Документация	73 файла, 22 примера
Размер бандла	567KB gzipped

Прогресс по Эпикам

• ✅ 5 эпиков завершено (Foundation, Products/Orders, Extended Modules, Integration, Testing)
• 🔄 2 эпика в работе (Documentation, Code Quality)
• 📝 3 эпика запланировано (Documentation Site, Web API Module)

⚠️ Для контрибьюторов: При создании или завершении эпиков/историй обновляйте PROJECT_STATUS_SUMMARY.md, чтобы статус проекта оставался актуальным. Этот файл автоматически генерируется и должен отражать последнее состояние реализации.

---

📚 Документация

Начало Работы

• Быстрый Старт - Начните работу за 5 минут
• Учебные Руководства - Пошаговые инструкции
• Справочник API - Полная TypeDoc документация

Руководства

• Лучшие Практики - Production паттерны
• Настройка Производительности - Оптимизация
• Безопасность - Безопасная интеграция
• Коммуникации - Чат с клиентами, вопросы-ответы и отзывы
• Реклама (Promotion) - Управление кампаниями
• Устранение Неполадок - Распространенные проблемы

🎯 Поддерживаемые Модули API

Все 11 модулей Wildberries API полностью поддерживаются со 100% покрытием API:

Модуль	Описание
General	Ping, новости, информация о продавце, проверка подключения
Products	Категории, CRUD, медиа, ценообразование, склад, запасы
Orders FBS	Выполнение продавцом, статус заказа, доставка, поставки
Orders FBW	Выполнение складом WB, планирование поставок
Finances	Баланс, транзакции, отчеты, выплаты
Analytics	Воронка продаж, поисковые запросы, история запасов, CSV отчеты
Reports	Отчеты о доходах, отчеты о продажах, экспорт данных
Communications	Чат с клиентами в реальном времени, вопросы-ответы по товарам, управление отзывами и рейтингами, предпросмотр чатов с последними сообщениями, НОВОЕ: закрепление отзывов на карточках товаров
Promotion	Кампании, промокоды, реклама ⚠️ Требуется Миграция - 4 метода устарели (2 февраля 2026)
Tariffs	Ставки комиссий, тарифные планы
In-Store Pickup	Заказы с самовывозом и управление
Orders DBS	Заказы DBS (Доставка Продавцом) - продавец хранит и доставляет товар напрямую покупателю, поддержка B2B, маркировка (SGTIN, IMEI)

📄 Лицензия

Лицензия для Личного Использования - Бесплатно для личного, образовательного и некоммерческого использования.

✅ Разрешено:

• Личное некоммерческое использование
• Образовательные цели
• Open source проекты (некоммерческие)
• Обучение и развитие навыков

❌ Запрещено Без Коммерческой Лицензии:

• Коммерческое использование в бизнес-среде
• Продажа или монетизация SDK
• Предоставление платных услуг на основе SDK
• Использование в коммерческих продуктах/сервисах

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

См. файл LICENSE для полных условий.

🤝 Участие в Проекте

Мы приветствуем вклад! Будь то сообщения об ошибках, запросы функций, улучшения документации или код.

→ Руководство по Участию

📞 Поддержка

• 📖 Документация: https://salacoste.github.io/daytona-wildberries-typescript-sdk/ru/
• ❓ FAQ: English | Русский
• 🐛 Сообщения об Ошибках: Открыть issue
• 💬 Обсуждения: GitHub Discussions

⚠️ Отказ от Ответственности

Это неофициальный SDK. Не аффилирован, не поддерживается официально и не одобрен Wildberries. Используйте на свой риск. Всегда обращайтесь к официальной документации Wildberries API за авторитетной информацией.

---

Made with ❤️ for the Wildberries developer community

Сделано с ❤️ для сообщества разработчиков Wildberries

⬆ Back to top / Наверх