wb-api-client — Python

Auto-generated Python client for the Wildberries Seller API. One package, thirteen sub-modules — one per API category. This README is regenerated on every release, so it always matches the code in this tree.

Install

pip install valeryverkhoturov-wb-api-client

Authentication

Every module accepts the same WB bearer JWT. The token is stored in a redacting wrapper — pydantic.SecretStr — so it does not leak under logs / print unless you explicitly ask for the raw value with .get_secret_value().

from wb_api_client.items import Configuration, ApiClient

cfg = Configuration(access_token="<your WB JWT>")
client = ApiClient(cfg)

Modules

Each row below is a sub-module you can import independently. Import path is wb_api_client.<slug>.

Per-module usage

general — Общее

В этом разделе:

• общая информация о WB API
• как начать работу с WB API
• как авторизоваться и создавать токены
• основные статус-коды ответов
• лимиты запросов
• как обратиться в поддержку С помощью методов этого раздела вы можете:
• проверить подключение к WB API
• получить новости портала продавцов
• получить информацию о продавце
• управлять пользователями продавца

Reference: https://dev.wildberries.ru/openapi/api-information

APIs: APIApi, Api, WBAPIApi

from wb_api_client.general import Configuration, ApiClient
from wb_api_client.general.api import APIApi

cfg = Configuration(access_token="<your WB JWT>")
api = APIApi(ApiClient(cfg))

items — Работа с товарами

С помощью методов этого раздела вы можете:

• создавать и редактировать карточки товаров
• получать категории, предметы, характеристики и бренды товаров
• загружать медиафайлы в карточки товаров
• настраивать ярлыки для поиска товаров
• работать с рекомендациями для товаров
• устанавливать цены и скидки
• управлять остатками товаров и складами, если вы работаете по модели продаж со склада продавца Вы можете протестировать методы работы с товарами в песочнице. Также в песочнице доступны специальные методы для управления карточками товаров

Узнать, как использовать методы в бизнес-кейсах, можно в инструкции по работе с товарами

Reference: https://dev.wildberries.ru/openapi/item-management

APIs: Api, DefaultApi

from wb_api_client.items import Configuration, ApiClient
from wb_api_client.items.api import Api

cfg = Configuration(access_token="<your WB JWT>")
api = Api(ApiClient(cfg))

orders-fbs — Заказы FBS

С помощью методов раздела Заказы FBS (Fulfillment by Seller) вы можете:

• получать информацию о сборочных заданиях и их статусах, отменять сборочные задания, получать стикеры
• добавлять, редактировать и удалять идентификаторы маркировки сборочных заданий
• управлять поставками
• создавать, редактировать и удалять пропуска на склады WB Вы можете протестировать методы заказов FBS в песочнице. Также в песочнице доступны специальные методы для эмуляции действий пользователя

Узнать, как использовать методы в бизнес-кейсах, можно в инструкции по работе с заказами FBS

Узнать больше о заказах FBS можно в справочном центре

Reference: https://dev.wildberries.ru/openapi/orders-fbs

APIs: Api, FBSApi

from wb_api_client.orders_fbs import Configuration, ApiClient
from wb_api_client.orders_fbs.api import Api

cfg = Configuration(access_token="<your WB JWT>")
api = Api(ApiClient(cfg))

orders-dbw — Заказы DBW

С помощью методов Заказы DBW (Деливери WB) вы можете:

• получать информацию о сборочных заданиях, управлять статусами и отменять сборочные задания
• получать, добавлять, редактировать и удалять метаданные сборочных заданий

Узнать, как использовать методы в бизнес-кейсах, можно в инструкции по работе с заказами DBW

Reference: https://dev.wildberries.ru/openapi/orders-dbw

APIs: DBWApi

from wb_api_client.orders_dbw import Configuration, ApiClient
from wb_api_client.orders_dbw.api import DBWApi

cfg = Configuration(access_token="<your WB JWT>")
api = DBWApi(ApiClient(cfg))

dbs — DBS

Узнать больше о модели DBS можно в справочном центре

Управление сборочными заданиями и идентификаторами маркировки DBS (Delivery by Seller).

Вы можете протестировать методы DBS в песочнице. Также в песочнице доступны специальные методы для эмуляции действий пользователя

Reference: https://dev.wildberries.ru/openapi/dbs

APIs: DBSApi

from wb_api_client.dbs import Configuration, ApiClient
from wb_api_client.dbs.api import DBSApi

cfg = Configuration(access_token="<your WB JWT>")
api = DBSApi(ApiClient(cfg))

in-store-pickup — Самовывоз

Управление сборочными заданиями и идентификаторами маркировки Самовывоза.

Вы можете протестировать методы Самовывоза в песочнице. Также в песочнице доступны специальные методы для эмуляции действий пользователя

Reference: https://dev.wildberries.ru/openapi/in-store-pickup

APIs: Api

from wb_api_client.in_store_pickup import Configuration, ApiClient
from wb_api_client.in_store_pickup.api import Api

cfg = Configuration(access_token="<your WB JWT>")
api = Api(ApiClient(cfg))

orders-fbw — Поставки FBW

Узнать больше о поставках FBW можно в справочном центре

В разделе описаны методы получения:

• информации для формирования поставок
• информации о поставках Вы можете создавать карточки товара в песочнице Контента, а потом использовать баркоды товаров в песочнице Поставок

Reference: https://dev.wildberries.ru/openapi/orders-fbw

APIs: Api

from wb_api_client.orders_fbw import Configuration, ApiClient
from wb_api_client.orders_fbw.api import Api

cfg = Configuration(access_token="<your WB JWT>")
api = Api(ApiClient(cfg))

promotion — Маркетинг и продвижение

Узнать больше о маркетинге и продвижении можно в справочном центре

Методы маркетинга и продвижения позволяют:

1. Получать информацию о кампаниях продвижения и медиакампаниях
2. Создавать и управлять кампаниями
3. Управлять финансами кампаний
4. Выгружать статистику кампаний продвижения и медиакампаний
5. Работать с календарём акций Данные синхронизируются с базой раз в 3 минуты. Статусы кампаний меняются раз в минуту. Ставки кампаний меняются раз в 30 секунд.

Вы можете протестировать методы продвижения в песочнице. Также в песочнице доступны специальные методы для управления тестовым балансом

Reference: https://dev.wildberries.ru/openapi/promotion

APIs: Api, DefaultApi

from wb_api_client.promotion import Configuration, ApiClient
from wb_api_client.promotion.api import Api

cfg = Configuration(access_token="<your WB JWT>")
api = Api(ApiClient(cfg))

communications — Общение с покупателями

Узнать больше об общении с покупателями можно в справочном центре

С помощью методов общения с покупателями вы можете работать с:

1. Вопросами и отзывами покупателей
2. Закреплёнными отзывами
3. Чатами с покупателями
4. Заявками покупателей на возврат Вы можете протестировать методы общения с покупателями в песочнице. Также в песочнице доступны специальные методы для управления тестовыми вопросами и отзывами

Узнать, как использовать методы в бизнес-кейсах, можно в инструкции по работе с разделом Общение с покупателями

Reference: https://dev.wildberries.ru/openapi/customer-communication

APIs: Api, DefaultApi

from wb_api_client.communications import Configuration, ApiClient
from wb_api_client.communications.api import Api

cfg = Configuration(access_token="<your WB JWT>")
api = Api(ApiClient(cfg))

rates — Тарифы

Узнать больше о тарифах можно в справочном центре

В разделе описаны методы получения:

1. Комиссий
2. Тарифов на поставку
3. Тарифов на остаток
4. Тарифов на возврат товаров продавцу

Reference: https://dev.wildberries.ru/openapi/rates

APIs: Api, DefaultApi

from wb_api_client.rates import Configuration, ApiClient
from wb_api_client.rates.api import Api

cfg = Configuration(access_token="<your WB JWT>")
api = Api(ApiClient(cfg))

analytics — Аналитика и данные

Узнать больше об аналитике и данных можно в справочном центре

В разделе описаны методы получения:

1. Воронки продаж
2. Ленты заказов
3. Поисковых запросов по вашим товарам
4. Истории остатков
5. Оценки товара
6. Аналитики продавца в формате CSV

Reference: https://dev.wildberries.ru/openapi/analytics

APIs: Api, CSVApi

from wb_api_client.analytics import Configuration, ApiClient
from wb_api_client.analytics.api import Api

cfg = Configuration(access_token="<your WB JWT>")
api = Api(ApiClient(cfg))

reports — Отчёты

Узнать больше об отчётах можно в справочном центре

С помощью этих методов вы можете получать основные отчёты и отчёты о:

1. Остатках на складах
2. Товарах с обязательной маркировкой
3. Удержаниях
4. Операциях при приёмке
5. Платном хранении
6. Продажах по регионам
7. Доле бренда в продажах
8. Заблокированных карточках
9. Возвратах и перемещении товаров

Reference: https://dev.wildberries.ru/openapi/reports

APIs: Api, CApi

from wb_api_client.reports import Configuration, ApiClient
from wb_api_client.reports.api import Api

cfg = Configuration(access_token="<your WB JWT>")
api = Api(ApiClient(cfg))

finances — Документы и бухгалтерия

Узнать больше о документах и бухгалтерии можно в справочном центре

Просмотр баланса, финансовых отчётов и документов продавца.

Reference: https://dev.wildberries.ru/openapi/documents-and-accounting

APIs: Api, DefaultApi

from wb_api_client.finances import Configuration, ApiClient
from wb_api_client.finances.api import Api

cfg = Configuration(access_token="<your WB JWT>")
api = Api(ApiClient(cfg))