Wildberries API TypeScript SDK v3.3.0
Wildberries API TypeScript SDK Main entry point
Modules
| Module | Description |
|---|---|
| <internal> | - |
Classes
| Class | Description |
|---|---|
| BaseClient | Base HTTP client for all Wildberries API modules |
| AuthenticationError | Authentication error thrown when API key is invalid or lacks permissions. |
| WBAPIError | Base error class for all Wildberries SDK errors. |
| PickupOrderNotFoundError | Error thrown when a pickup order is not found |
| InvalidOrderStateError | Error thrown when an order state transition is invalid |
| CustomerVerificationError | Error thrown when customer identity verification fails |
| MetadataValidationError | Error thrown when product metadata validation fails |
| NetworkError | Network error thrown for connection failures, timeouts, and server errors. |
| CampaignNotFoundError | Error thrown when a campaign is not found by its ID. |
| InvalidBidError | Error thrown when bid amount is invalid or below minimum. |
| BudgetExceededError | Error thrown when campaign budget is exceeded or insufficient. |
| InvalidCampaignStateError | Error thrown when attempting invalid campaign state transitions. |
| RateLimitError | Rate limit error thrown when API rate limits are exceeded. |
| ValidationError | Validation error thrown when request data fails validation. |
| WildberriesSDK | Main SDK class providing access to all Wildberries API modules. |
| AnalyticsModule | - |
| CommunicationsModule | - |
| FinancesModule | - |
| GeneralModule | - |
| InStorePickupModule | - |
| OrdersDbsModule | Orders DBS Module for managing Delivery by Seller orders |
| OrdersFbsModule | - |
| OrdersFbwModule | - |
| ProductsModule | - |
| PromotionModule | - |
| ReportsModule | - |
| TariffsModule | - |
| UserManagementModule | - |
Interfaces
| Interface | Description |
|---|---|
| RateLimitConfig | Configuration for rate limiting a specific endpoint. |
| OperationMetadata | Metadata for a single SDK operation |
| SDKConfig | Configuration options for initializing the Wildberries SDK |
| RequestOptions | Per-request options that can override SDK defaults |
| AccessItem | Элемент настройки доступа к разделу профиля продавца |
| InviteeInfo | Информация о приглашении пользователя |
| UserInfo | Информация о пользователе профиля продавца |
| GetUsersResponse | Ответ на запрос списка пользователей |
| GetUsersParams | Параметры запроса для получения списка пользователей |
| CreateInviteRequest | Запрос на создание приглашения пользователя |
| CreateInviteResponse | Ответ на запрос создания приглашения |
| UserAccess | Настройки доступа для конкретного пользователя |
| UpdateUserAccessRequest | Запрос на обновление настроек доступа пользователей |
| UserManagementErrorResponse | Ответ с информацией об ошибке от User Management API |
| SupplyCostInput | Input parameters for supply cost calculation |
| SupplyCostResult | Result of supply cost calculation |
| CompareTariffsInput | Input parameters for tariff comparison |
| TariffData | Tariff data from a single source |
| TariffDifference | Percentage differences between inventory and supply tariffs |
| TariffComparison | Complete tariff comparison result |
Type Aliases
| Type Alias | Description |
|---|---|
| EndpointLimits | Mapping of endpoint keys to their rate limit configurations. |
| AccessCode | Код раздела профиля продавца, к которому пользователь получит доступ. |
| TariffRecommendation | Recommendation based on tariff comparison |
Variables
| Variable | Description |
|---|---|
| analyticsRateLimits | - |
| communicationsRateLimits | - |
| financesRateLimits | - |
| generalRateLimits | - |
| inStorePickupRateLimits | - |
| operationMetadata | Registry of operation metadata for all SDK operations |
| ordersDbsRateLimits | - |
| ordersFbsRateLimits | - |
| ordersFbwRateLimits | - |
| productsRateLimits | - |
| promotionRateLimits | - |
| ALL_RATE_LIMITS | Aggregated rate limit configuration for all SDK modules. |
| reportsRateLimits | - |
| tariffsRateLimits | - |
| userManagementRateLimits | - |
| version | SDK version |
Functions
| Function | Description |
|---|---|
| isOperationReadonly | Check if an operation is readonly (safe to retry) |
| getOperationCategory | Get the API category for an operation |
| getOperationRateLimitKey | Get the rate limit key for an operation |
| getOperationMetadata | Get full metadata for an operation |
| getOperationsByCategory | Get all operations for a specific category |
| getReadonlyOperations | Get all readonly operations |
| getWriteOperations | Get all write operations (not readonly) |
| calculateSupplyCost | Calculates the total supply cost including acceptance, storage, and logistics |
| compareTariffs | Compare tariffs between inventory storage (tariffs/box) and supply (acceptance/coefficients) APIs |
References
default
Renames and re-exports WildberriesSDK