Guides
In-depth guides for production deployment and advanced SDK usage.
New in v3.10.0
Returns Module (sdk.returns) — Unified aggregator combining FBO analytics, FBS order history, and Finance reports into a single ReturnItem[]. One method call replaces your own join logic across three endpoints with different update cadences. Includes classifyReturnReason(), partial-failure transparency, and getReturnStats() for per-SKU/category aggregation.
New in v3.9.0 — Deadline April 29, 2026
Mandatory Product Characteristics -- WB now requires mandatory characteristics when creating product cards in 10+ categories. Check isRequiredForCreate in getObjectCharc() response and include required characteristics in create/update requests.
New in v3.7.0
- Finance Reports v5 to v1 Migration -- The v5
getSupplierReportDetailByPeriod()endpoint will be disabled on 2026-07-15. Migrate togetSalesReportsDetailed()now. - Tracking Promotion Channels with Substitute Articles -- Reconcile external marketing spend against settled revenue using substitute article fields.
Migration Guides
IMPORTANT
- Finance Reports v5 endpoint will be disabled 2026-07-15 -- migrate to v1 immediately.
- If you are using Promotion module Type 8 campaigns, migrate to Type 9 before February 2, 2026.
- Migration v3.0.0 - Complete Deprecation Guide - Comprehensive guide for migrating to v3.0.0 (62 removed methods, 14 removed types)
- Finance Reports v5 → v1 Migration - Migrate from deprecated
getSupplierReportDetailByPeriod()togetSalesReportsDetailed()-- field mapping, string money amounts withparseMoneyAmount, and code examples (deadline: 2026-07-15) - Migration v2.7 - Analytics v3 Sales Funnel - Migrate from deprecated v2 Sales Funnel methods to new v3 endpoints
- Type 8 → Type 9 Campaign Migration - Migrate from standard bid campaigns (type 8) to custom/standard bid campaigns (type 9)
- Type 8 → Type 9 (alternate) - Original deprecation notice for Type 8 campaign removal
- Migration v2.3 - Promotion Required Parameters - Breaking changes in Promotion module method signatures
- Migration DBS Legacy to Bulk - Migrate from deprecated single-order DBS methods to bulk APIs
Production Guides
- Best Practices - Error handling, security, and testing patterns
- Performance Tuning - Optimize rate limits, caching, and memory
- Performance Tuning (Extended) - Comprehensive performance optimization for production deployments -- rate limits, caching, monitoring, and benchmarking
- Security - API key management and secure integration
- Testing - Unit and integration testing strategies
- Troubleshooting - Common issues and solutions
- Configuration - SDK configuration options
SDK Usage
Product Management
- Working with Product Cards - Complete guide to fetching, filtering, and paginating product cards
- Product Card Merging & Analytics - Merged cards, advertising traffic distribution, and cross-variant analytics
- Mandatory Product Characteristics - Required characteristics for card creation (April 29, 2026 enforcement)
Orders & Logistics
- Orders DBS Guide - Getting started with Delivery by Seller (DBS) order processing
- DBS Workflows - End-to-end DBS workflow patterns and automation
- In-Store Pickup Guide - Managing in-store pickup point orders
- Orders FBW (Supplies) Guide - Fulfillment by Wildberries supply management
- Stock Management - Inventory control and tracking
- Returns Handling - Returns processing
- Supplies Planning - Planning supplies to WB warehouses, acceptance coefficients, and FBW vs FBS strategy
Advertising & Marketing
- Promotion & Advertising - Campaign management, bids, budget, and analytics
- Promotion Module Getting Started - Complete guide to managing advertising campaigns, bidding, and search clusters
- Advertising Statistics Guide - Detailed advertising performance metrics and reporting
- Advertising Campaign Best Practices - Optimization strategies for advertising campaigns
- Advertising Campaigns (RU) - Complete advertising management guide in Russian
- User Management - Managing user accounts and permissions
Financial Operations
- Commissions & Fees - Tariffs and commission calculations
- Realization Reports - Sales and realization reports
- Reports Module - Financial reporting
- Storage Fees - Warehouse costs integration
Finance Reconciliation
- Returns Module - Unified
sdk.returnsaggregator combining FBO, FBS, and Finance sources into a single ReturnItem array with full transparency about source health and limitations. (New in v3.10.0) - Buyout & Return Reconciliation - Classify FBO/FBS return reasons, enrich returns with
orderType, and reconcile against buyout counts per nmId using three pure client-side helpers. (New in v3.9.3) - Tracking Promotion Channels with Substitute Articles - Reconcile external marketing spend against settled revenue using substitute article fields from the Wildberries financial report. Uses
parseMoneyAmountwhen working with the v1 endpoint. (New in v3.7.0) - Finance Reports v5 → v1 Migration - Full field mapping from snake_case (v5) to camelCase (v1), string money amounts with the
parseMoneyAmounthelper, and drop-in code examples (deadline: 2026-07-15)
Analytics Guides
- Sales Funnel Analytics - Funnel metrics, period comparison, daily trends
- Sales Funnel Best Practices - Best practices for interpreting and acting on sales funnel data
- Search Queries Analytics - SEO optimization, search positions, keyword performance
- Seller Analytics CSV - Long-term CSV reports with polling workflow (requires Jam)
Customer Interaction
- Customer Communication - Questions, reviews, pinned feedback, buyer chat, returns
- Communications Guide - Complete guide to customer engagement features: chat, Q&A, and reviews management
- Communications Getting Started - Complete guide to using the Communications module for Q&A, reviews, chat, claims, and pinned reviews
Subscription & Tariffs
- Jam Subscription Detection - Detect Jam subscription tier to optimize analytics limits
- Tariffs Overview - Understanding inventory vs supply tariffs
- Supplies & Tariffs - Supply acceptance coefficients, cost calculations, and tariff comparisons