Skip to content

Wildberries API TypeScript SDK v2.4.2

Wildberries API TypeScript SDK Main entry point

Modules

ModuleDescription
<internal>-

Classes

ClassDescription
BaseClientBase HTTP client for all Wildberries API modules
AuthenticationErrorAuthentication error thrown when API key is invalid or lacks permissions.
WBAPIErrorBase error class for all Wildberries SDK errors.
PickupOrderNotFoundErrorError thrown when a pickup order is not found
InvalidOrderStateErrorError thrown when an order state transition is invalid
CustomerVerificationErrorError thrown when customer identity verification fails
MetadataValidationErrorError thrown when product metadata validation fails
NetworkErrorNetwork error thrown for connection failures, timeouts, and server errors.
CampaignNotFoundErrorError thrown when a campaign is not found by its ID.
InvalidBidErrorError thrown when bid amount is invalid or below minimum.
BudgetExceededErrorError thrown when campaign budget is exceeded or insufficient.
InvalidCampaignStateErrorError thrown when attempting invalid campaign state transitions.
RateLimitErrorRate limit error thrown when API rate limits are exceeded.
ValidationErrorValidation error thrown when request data fails validation.
WildberriesSDKMain SDK class providing access to all Wildberries API modules.
AnalyticsModule-
CommunicationsModule-
FinancesModule-
GeneralModule-
InStorePickupModule-
OrdersFbsModule-
OrdersFbwModule-
ProductsModule-
PromotionModule-
ReportsModule-
TariffsModule-

Interfaces

InterfaceDescription
RateLimitConfigConfiguration for rate limiting a specific endpoint.
SDKConfigConfiguration options for initializing the Wildberries SDK
RequestOptionsPer-request options that can override SDK defaults

Type Aliases

Type AliasDescription
EndpointLimitsMapping of endpoint keys to their rate limit configurations.

Variables

VariableDescription
generalRateLimits-
ordersFbsRateLimits-
ordersFbwRateLimits-
promotionRateLimits-
ALL_RATE_LIMITSAggregated rate limit configuration for all SDK modules.
tariffsRateLimits-
versionSDK version

References

default

Renames and re-exports WildberriesSDK

Made with ❤️ for the Wildberries developer community