API Reference

Complete TypeScript API reference for the Wildberries SDK. Browse all modules, classes, interfaces, and type definitions.

SDK Core

• WildberriesSDK - Main SDK class aggregating all 14 modules
• BaseClient - HTTP client with retry and timeout handling
• RateLimiter - Per-endpoint rate limit enforcement
• RetryHandler - Exponential backoff retry logic

SDK Modules

Complete reference for all 14 API modules covering product management, orders, finances, analytics, and more.

Module	Description	API Domain
GeneralModule	Ping, news, seller information	common-api
ProductsModule	Product catalog, categories, pricing, stock	content-api
OrdersFbsModule	Seller warehouse fulfillment orders	marketplace-api
OrdersFbwModule	Wildberries warehouse fulfillment	marketplace-api
OrdersDbsModule	Delivery by Seller (DBS) orders	marketplace-api
FinancesModule	Balance, transactions, financial reports	finance-api, statistics-api
AnalyticsModule	Sales analytics, performance metrics, CSV reports	seller-analytics-api
ReportsModule	Async report generation and retrieval	statistics-api
CommunicationsModule	Customer chat, Q&A, reviews	common-api
PromotionModule	Campaigns, promo codes, advertising	advert-api
TariffsModule	Commission rates, tariff info, fees	-
InStorePickupModule	Click & collect pickup orders	-
UserManagementModule	Seller profile user & access management	common-api
ReturnsModule	Unified FBO + FBS + finance returns aggregator	aggregator

Configuration Interfaces

Configure the SDK for different environments and use cases:

• SDKConfig - Main SDK configuration interface
• RetryConfig - Retry logic configuration
• RateLimitConfig - Rate limiting configuration

Error Classes

Comprehensive error hierarchy for precise error handling:

• WBAPIError - Base error class for all SDK errors
• AuthenticationError - 401/403 authentication errors
• RateLimitError - 429 rate limit errors
• ValidationError - 400/422 validation errors
• NetworkError - Network failure errors

Common Interfaces

Frequently used public interfaces across modules:

• RequestOptions - Per-request SDK options
• GetStocksResponse - Product stock response
• ReturnsApiRequest - Unified returns query
• ReturnsApiResponse - Unified returns result and source telemetry
• GetUsersResponse - Seller-profile users

Type Definitions

Browse complete type definitions for API requests and responses:

• Interfaces - All public interface definitions
• Type Aliases - Public type aliases
• Variables - Exported variables and constants

Quick Start Example

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

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

// Access any of the 14 modules
const categories = await sdk.products.getParentAll();
const orders = await sdk.ordersFBS.getOrders({ limit: 10 });
const balance = await sdk.finances.getBalance();

Error Handling Example

import {
  WBAPIError,
  RateLimitError,
  AuthenticationError,
  ValidationError
} from 'daytona-wildberries-typescript-sdk';

try {
  const result = await sdk.products.getParentAll();
} catch (error) {
  if (error instanceof RateLimitError) {
    // SDK automatically retries, log for monitoring
    console.warn('Rate limit hit', { retryAfter: error.retryAfter });
  } else if (error instanceof AuthenticationError) {
    // Don't retry - fix API key
    console.error('Invalid API key');
  } else if (error instanceof ValidationError) {
    // Fix request data
    console.error('Validation error', { message: error.message });
  } else if (error instanceof WBAPIError) {
    // Other API errors
    console.error('API error', { statusCode: error.statusCode });
  }
}

Getting Started

New to the SDK? Check out these resources:

• Quick Start Guide - Get up and running in 5 minutes
• Configuration Guide - Configure SDK for your environment
• Best Practices - Production-ready patterns and error handling
• Examples - Working code examples

Support & Resources

• GitHub Repository - Source code and issue tracking
• Official Wildberries API Documentation - Wildberries API reference
• npm Package - Package on npm registry

---

Tip: Use your IDE's autocomplete with TypeScript to explore all available methods and properties. The SDK is fully typed for excellent developer experience.