Skip to content

Wildberries API TypeScript SDK / <internal>

<internal>

Classes

ClassDescription
_TokenBucketInternal token bucket implementation for rate limiting.
RateLimiterRate limiter for API endpoints using the token bucket algorithm.
RetryHandlerRetryHandler - Automatic retry with exponential backoff

Interfaces

InterfaceDescription
RetryConfigConfiguration options for retry behavior
MainRequestПараметры запроса для формирования главной страницы: - currentPeriod — текущий период - pastPeriod — предыдущий период для сравнения
MainResponse-
CommonInfo-
PositionInfoИнформация о позиции товара
SearchReportPositionChartItem-
SearchReportPositionClustersКоличество товаров со средней позицией в поиске: - firstHundred — от 1 до 100 - secondHundred — от 101 до 200 - below — от 201 и ниже
VisibilityInfoВидимость карточек и переходы в карточки. По дням, неделям, месяцам
TableGroupItemК группе товаров относятся все карточки, подходящие хотя бы по одному из параметров: - subjectName — название предмета - brandName — бренд - tagName — название ярлыка
TableProductItem-
TableGroupRequestПараметры запроса для пагинации по группам: - currentPeriod — текущий период - pastPeriod — предыдущий период для сравнения
TableGroupResponse-
TableDetailsRequestПараметры запроса для пагинации по товарам в группе: - currentPeriod — текущий период - pastPeriod — предыдущий период для сравнения
TableDetailsResponse-
ProductSearchTextsRequestПараметры для запроса по рейтингу поисковых запросов: - currentPeriod — текущий период - pastPeriod — предыдущий период для сравнения
ProductSearchTextsResponse-
TableSearchTextItem-
ProductOrdersRequest-
ProductOrdersResponse-
ProductOrdersTextItem-
ProductOrdersMetrics-
OrderByПараметры сортировки
OrderByGrTeПараметры сортировки
PeriodOrdersRequestТекущий период. Максимум 7 суток
PeriodТекущий период
PastPeriodПрошлый период для сравнения. Количество дней — меньше или равно currentPeriod
CommonResponsePropertiesРезультат запроса
NmReportDetailRequest-
NmReportDetailHistoryRequest-
NmReportGroupedHistoryRequest-
NmReportDetailResponse-
NmReportDetailHistoryResponse-
NmReportGroupedHistoryResponse-
SalesFunnelProductReq-
SalesFunnelGroupReq-
SearchReportGroupReq-
SearchReportProductReq-
SearchReportTextReq-
StocksReportReq-
NmReportRetryReportRequest-
NmReportCreateReportResponse-
NmReportGetReportsResponse-
NmReportRetryReportResponse-
CommonReportFiltersОбщие фильтры по отчёту
PeriodStПериод
TableOrderByВид сортировки данных
TableGroupResponseSt-
TableGroupItemStДанные по группе
TableCommonMetricsМетрики
FloatGraphByPeriodItemСреднее количество заказов за месяц
TableProductItemStДанные по товару
CommonProductFiltersОбщие фильтры по товару
TableProductResponse-
CommonSizeFiltersОбщие фильтры по размеру
TableSizeResponse-
TableOfficeItemДанные по складу
CommonShippingOfficeFiltersОбщие фильтры по регионам отгрузки
TableShippingOfficeResponse-
TableShippingOfficeItemДанные по региону отгрузки
TableShippingOfficeMetricsОбщие метрики по регионам/складам отгрузки
ResponseTemplateУспешно
PostTemplate-
PatchDelResp-
LastMessageИнформация о последнем сообщении в чате
Chat-
ChatsResponse-
Event-
EventAttachmentsВложения
File-
GoodCardИнформация о заказе
ImageИзображение
MessageResponse-
EventsResponse-
EventsResult-
RequestDownloadAuto-generated TypeScript types for finances module Generated from: wildberries_api_doc/13-finances.yaml
GetCategories-
GetList-
GetDoc-
GetDocs-
DetailReportItem-
ApiCheckedIdentityAuto-generated TypeScript types for in-store-pickup module Generated from: wildberries_api_doc/06-in-store-pickup.yaml
ApiCheckIdentityRequest-
ApiGTINRequest-
ApiIMEIRequest-
ApiNewOrder-
ApiNewOrders-
ApiOrder-
ApiOrderClientInfo-
ApiOrderClientInfoResp-
ApiOrderStatus-
ApiOrderStatuses-
ApiOrders-
ApiOrdersMeta-
ApiOrdersRequest-
ApiSGTINsRequest-
ApiUINRequest-
ApiBaseMeta-
PassOfficeДанные о складе, для которого требуется пропуск
Order-
Supply-
OrderNew-
SupplyOrder-
SupplyTrbx-
TrbxStickers-
MetaМетаданные сборочного задания
PassДанные о пропуске продавца
CrossborderTurkeyClientInfo-
CrossborderTurkeyClientInfoResp-
OrdersRequestAPI-
ModelsTransitTariffAuto-generated TypeScript types for orders-fbw module Generated from: wildberries_api_doc/07-orders-fbw.yaml
ModelsVolumeTariff-
ModelsBox-
ModelsGoodInBox-
ModelsSuppliesFiltersRequest-
ModelsGoodInSupply-
ModelsDateFilterRequest-
ModelsSupplyDetails-
ModelsSupply-
ModelsAcceptanceCoefficient-
ModelsWarehousesResultItems-
ModelsGood-
ModelsOptionsResultModel-
StoreContactRequestBodyКонтакты склада продавца
ResponseCardCreate-
RequestMoveNmsImtConn-
RequestMoveNmsImtDisconn-
ResponseContentError-
OfficeДанные о складе WB
WarehouseДанные о складе продавца
ResponsePublicViewerPublicErrorsTableListV2-
ModelsErrorTableListPublicRespV2Данные ответа
ModelsErrorTableListPublicRespV2Item-
ViewerContractPublicErrorsCursorOutputПагинатор
ModelsErrorSubject-
ModelsErrorBrand-
RequestPublicViewerPublicErrorsTableListV2-
SwaggerPublicErrorsCursorInputПагинатор
SwaggerPublicErrorsOrderV2Порядок выдачи пакетов
V0GetConfigCategoriesResponse-
V0AdvertMultiBidItem-
V0AdvertMultibid-
ResponseWithReturn-
ResponseInfoAdvert-
ResponseInfoAdvertType8-
ResponseInfoAdvertType9-
GetAuctionAdverts-
AuctionAdvertNMsSettings-
AuctionAdvertSubjectПредмет
AuctionAdvertBidsСтавки
AuctionAdvertSettingsНастройки кампании
TimestampsВременные отметки
StatInterval-
StatDate-
Stat-
StatsBlok1-
StatsBlok2-
RequestWithDate-
RequestWithCampaignID-
RequestWithInterval-
V0KeywordsStatistic-
V0KeywordsStatistics-
V0KeywordsStatisticsResponse-
FullStatsItemСтатистика по одной кампании за период, указанный в запросе. По всем артикулам WB и платформам
IncomesItemAuto-generated TypeScript types for reports module Generated from: wildberries_api_doc/12-reports.yaml
StocksItem-
OrdersItem-
SalesItem-
ExciseReportRequest-
ExciseReportResponse-
ModelsExciseReportResponse-
Penalty-
Measurement-
GetTasksResponse-
GetTasksResponseData-
CreateTaskResponse-
CreateTaskResponseData-
ModelsTariffsBoxResponseAuto-generated TypeScript types for tariffs module Generated from: wildberries_api_doc/10-tariffs.yaml
ModelsWarehousesBoxRates-
ModelsWarehouseBoxRates-
ModelsTariffsPalletResponse-
ModelsWarehousesPalletRates-
ModelsWarehousePalletRates-
ModelsReturnTariffsResponse-
ModelsWarehousesReturnRates-
ModelsWarehouseReturnRates-
TariffsBoxResponse-
TariffsPalletResponse-
ReturnTariffsResponse-
Commission-
CommissionChina-
CommissionTurkey-
CommissionUzbekistan-
CommissionUAE-

Type Aliases

Type AliasDescription
PositionClusterТовары с какой средней позицией в поиске показывать в отчёте: - all — все - firstHundred — от 1 до 100 - secondHundred — от 101 до 200 - below — от 201 и ниже
TableGroupRequestSt-
StockTypeТип складов хранения товаров: - "" — все - wb — Склады WB - mp — Склады Маркетплейс (FBS)
AvailabilityFiltersДоступность товара: - deficient — Дефицит - actual — Актуальный - balanced — Баланс - nonActual — Неактуальный - nonLiquid — Неликвид - invalidData — Не рассчитано
TableGroupFieldCортировка по полю: - ordersCount — Заказы, шт. - ordersSum — Заказы, сумма - avgOrders — Среднее количество заказов в день - buyoutCount — Выкупы, шт. - buyoutSum — Выкупы, сумма - buyoutPercent — Процент выкупа - stockCount — Остатки на текущий день, шт. - stockSum — Стоимость остатков на текущий день - saleRate — Оборачиваемость текущих остатков - avgStockTurnover — Оборачиваемость средних остатков - toClientCount — В пути к клиенту, шт. - fromClientCount — В пути от клиента, шт. - minPrice — Минимальная цена продавца со скидкой продавца (без учёта скидки WB Клуба) - maxPrice — Максимальная цена продавца со скидкой продавца (без учёта скидки WB Клуба) - officeMissingTime — Время отсутствия товара на складе - lostOrdersCount — Упущенные заказы, шт. - lostOrdersSum — Упущенные заказы, сумма - lostBuyoutsCount — Упущенные выкупы, шт. - lostBuyoutsSum — Упущенные выкупы, сумма
OrderByModeПорядок сортировки: - asc — по возрастанию - desc — по убыванию
TableGroupsМножество данных по группам
TableProductRequestПараметры запроса об остатках по товарам
ResponseFeedbackМассив отзывов
SenderОтправитель: - client — покупатель - seller — продавец - wb — Wildberries
ModelsHandySupplyStatus-
PlacementTypeМеста размещения: - search — поиск - recommendation — рекомендации - combined — поиск и рекомендации
DailyStats1-
Stats1-
DailyStats2-
Stats2-
DaysСтатистка по дням
BoosterStatsСтатистика по средней позиции товара на страницах поисковой выдачи и каталога (для кампаний с единой ставкой)
ResponseWithIntervalОтвет при запросе с interval
ResponseWithDateОтвет при запросе с dates
ResponseFullStatsСтатистика по кампаниям за период, указанный в запросе. По всем артикулам WB и платформам
ModelsExciseReportResponseData-
ResponsePaidStorage-

Made with ❤️ for the Wildberries developer community