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 11 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 11 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 |
| 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 | - |
| CommunicationsModule | Customer chat, Q&A, reviews | - |
| PromotionModule | Campaigns, promo codes, advertising | - |
| TariffsModule | Commission rates, tariff info, fees | - |
| InStorePickupModule | Pickup point management | - |
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 interfaces across modules:
Product Management
- ProductCard - Product card data structure
- CreateProductRequest - Product creation request
- PricingUpdate - Pricing update request
- StockInfo - Stock information
Order Management
- Order - Order data structure
- OrderStatus - Order status information
- GetOrdersResponse - Orders list response
Financial Data
- BalanceResponse - Account balance response
- Transaction - Transaction data structure
- Payout - Payout information
Analytics Data
- CardStatistics - Product card statistics
- CategoryPerformanceResponse - Category performance metrics
Type Definitions
Browse complete type definitions for API requests and responses:
- Interfaces - All interface definitions (261 total)
- Type Aliases - Type alias definitions (46 total)
- Enumerations - Enum definitions (7 total)
- Variables - Exported variables and constants
Quick Start Example
typescript
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 11 modules
const categories = await sdk.products.getParentAll();
const orders = await sdk.ordersFBS.getOrders({ limit: 10 });
const balance = await sdk.finances.getBalance();Error Handling Example
typescript
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.