Wildberries API TypeScript SDK / PromotionModule

Class: PromotionModule

Defined in: modules/promotion/index.ts:10

Constructors

Constructor

new PromotionModule(client: BaseClient): PromotionModule;

Defined in: modules/promotion/index.ts:11

Parameters

Parameter	Type
`client`	`BaseClient`

Returns

PromotionModule

Methods

getPromotionCount()

getPromotionCount(): Promise<{
  adverts?: {
     type?: number;
     status?: number;
     count?: number;
     advert_list?: {
        advertId?: number;
        changeTime?: string;
     }[];
  }[];
  all?: number;
}>;

Defined in: modules/promotion/index.ts:27

Списки кампаний

Метод возвращает списки всех рекламных кампаний продавца с их ID. Кампании сгруппированы по типу и статусу, у каждой указана дата последнего изменения. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 5 запросов | 200 миллисекунд | 5 запросов | </div>

Returns

Promise<{ adverts?: { type?: number; status?: number; count?: number; advert_list?: { advertId?: number; changeTime?: string; }[]; }[]; all?: number; }>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getPromotionCount();
console.log(result);

createPromotionAdvert()

createPromotionAdvert(data: number[], options?: {
  status?: -1 | 4 | 7 | 8 | 9 | 11;
  type?: 4 | 7 | 8 | 5 | 6;
  order?: "create" | "change" | "id";
  direction?: "desc" | "asc";
}): Promise<
  | ResponseInfoAdvertType8
  | ResponseInfoAdvert
| ResponseInfoAdvertType9[]>;

Defined in: modules/promotion/index.ts:47

Информация о кампаниях

Метод возвращает информацию о рекламных кампаниях с устаревшими типами (4-8) по их статусам, типам и ID. <br><br> Для получения информации о кампаниях с типом 9 используйте отдельный метод. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 5 запросов | 200 миллисекунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`data`	`number`[]	Request body data
`options?`	{ `status?`: `-1` \| `4` \| `7` \| `8` \| `9` \| `11`; `type?`: `4` \| `7` \| `8` \| `5` \| `6`; `order?`: `"create"` \| `"change"` \| `"id"`; `direction?`: `"desc"` \| `"asc"`; }	Query parameters
`options.status?`	`-1` \| `4` \| `7` \| `8` \| `9` \| `11`	-
`options.type?`	`4` \| `7` \| `8` \| `5` \| `6`	-
`options.order?`	`"create"` \| `"change"` \| `"id"`	-
`options.direction?`	`"desc"` \| `"asc"`	-

Returns

Promise< | ResponseInfoAdvertType8 | ResponseInfoAdvert | ResponseInfoAdvertType9[]>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.createPromotionAdvert({}, {});
console.log(result);

getAuctionAdverts()

getAuctionAdverts(options?: {
  ids?: string;
  statuses?: "-1" | "4" | "7" | "8" | "9" | "11";
  payment_type?: "cpm" | "cpc";
}): Promise<GetAuctionAdverts>;

Defined in: modules/promotion/index.ts:66

Информация о кампаниях с ручной ставкой

Метод возвращает информацию о рекламных кампаниях с ручной ставкой по их статусам, типам оплаты и ID. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 5 запросов | 200 миллисекунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `ids?`: `string`; `statuses?`: `"-1"` \| `"4"` \| `"7"` \| `"8"` \| `"9"` \| `"11"`; `payment_type?`: `"cpm"` \| `"cpc"`; }	Query parameters
`options.ids?`	`string`	-
`options.statuses?`	`"-1"` \| `"4"` \| `"7"` \| `"8"` \| `"9"` \| `"11"`	-
`options.payment_type?`	`"cpm"` \| `"cpc"`	-

Returns

Promise<GetAuctionAdverts>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getAuctionAdverts({});
console.log(result);

getAdvConfig()

getAdvConfig(): Promise<{
  categories?: V0GetConfigCategoriesResponse[];
  config?: {
     description?: string;
     name?: string;
     value?: string;
  }[];
}>;

Defined in: modules/promotion/index.ts:84

Конфигурационные значения Продвижения

Метод возвращает допустимые значения основных параметров конфигурации кампаний: например, минимальные ставки, доступные категории и максимальное количество товаров, которые можно добавить в кампанию. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 1 запрос | 1 минута | 1 запрос | </div>

Returns

Promise<{ categories?: V0GetConfigCategoriesResponse[]; config?: { description?: string; name?: string; value?: string; }[]; }>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getAdvConfig();
console.log(result);

createBidsMin()

createBidsMin(data: {
  advert_id: number;
  nm_ids: number[];
  payment_type: "cpm" | "cpc";
  placement_types: ("combined" | "search" | "recommendation")[];
}): Promise<{
  bids: {
     bids: {
        type: PlacementType;
        value: number;
     }[];
     nm_id: number;
  }[];
}>;

Defined in: modules/promotion/index.ts:103

Минимальные ставки для карточек товаров

Метод возвращает минимальные ставки для карточек товаров по типу оплаты и местам размещения. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 20 запросов | 3 секунды | 5 запросов | </div>

Parameters

Parameter	Type	Description
`data`	{ `advert_id`: `number`; `nm_ids`: `number`[]; `payment_type`: `"cpm"` \| `"cpc"`; `placement_types`: (`"combined"` \| `"search"` \| `"recommendation"`)[]; }	Request body data
`data.advert_id`	`number`	-
`data.nm_ids`	`number`[]	-
`data.payment_type`	`"cpm"` \| `"cpc"`	-
`data.placement_types`	(`"combined"` \| `"search"` \| `"recommendation"`)[]	-

Returns

Promise<{ bids: { bids: { type: PlacementType; value: number; }[]; nm_id: number; }[]; }>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.createBidsMin({});
console.log(result);

createAdvSaveAd()

createAdvSaveAd(data: {
  type?: number;
  name?: string;
  subjectId?: number;
  sum?: number;
  btype?: number;
  on_pause?: boolean;
  nms?: number[];
  cpm?: number;
}): Promise<string>;

Defined in: modules/promotion/index.ts:122

Создать кампанию с единой ставкой

Метод создаёт кампанию с единой ставкой для продвижения товаров в: - каталоге - поиске - карточках товаров - рекомендациях на главной странице WB <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 20 секунд | 1 запрос | 20 секунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`data`	{ `type?`: `number`; `name?`: `string`; `subjectId?`: `number`; `sum?`: `number`; `btype?`: `number`; `on_pause?`: `boolean`; `nms?`: `number`[]; `cpm?`: `number`; }	Request body data
`data.type?`	`number`	-
`data.name?`	`string`	-
`data.subjectId?`	`number`	-
`data.sum?`	`number`	-
`data.btype?`	`number`	-
`data.on_pause?`	`boolean`	-
`data.nms?`	`number`[]	-
`data.cpm?`	`number`	-

Returns

Promise<string>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.createAdvSaveAd({});
console.log(result);

createSeacatSaveAd()

createSeacatSaveAd(data?: {
  name?: string;
  nms?: number[];
  bid_type?: "manual" | "unified";
  placement_types?: ("search" | "recommendations")[];
}): Promise<number>;

Defined in: modules/promotion/index.ts:141

Создать кампанию

Метод создаёт кампанию: - с ручной ставкой для продвижения товаров в поиске и/или рекомендациях - с единой ставкой для продвижения товаров одновременно в поиске и рекомендациях Тип всех созданных этим методом кампаний — 9. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 5 запросов | 12 секунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`data?`	{ `name?`: `string`; `nms?`: `number`[]; `bid_type?`: `"manual"` \| `"unified"`; `placement_types?`: (`"search"` \| `"recommendations"`)[]; }	Request body data
`data.name?`	`string`	-
`data.nms?`	`number`[]	-
`data.bid_type?`	`"manual"` \| `"unified"`	-
`data.placement_types?`	(`"search"` \| `"recommendations"`)[]	-

Returns

Promise<number>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.createSeacatSaveAd({});
console.log(result);

getSupplierSubjects()

getSupplierSubjects(): Promise<{
  id?: number;
  name?: string;
  count?: number;
}[]>;

Defined in: modules/promotion/index.ts:159

Предметы для кампаний

Метод возвращает список предметов, которые можно добавить в рекламную кампанию. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 12 секунд | 1 запрос | 12 секунд | 5 запросов | </div>

Returns

Promise<{ id?: number; name?: string; count?: number; }[]>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getSupplierSubjects();
console.log(result);

createSupplierNm()

createSupplierNm(data?: number[]): Promise<{
  title?: string;
  nm?: number;
  subjectId?: number;
}[]>;

Defined in: modules/promotion/index.ts:178

Карточки товаров для кампаний

Метод возвращает список карточек товаров, которые можно добавить в рекламную кампанию. Для получения карточек необходимы ID предметов, также доступных для добавления в кампанию. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 5 запросов | 12 секунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`data?`	`number`[]	ID предметов, для которых нужно получить карточки товаров

Returns

Promise<{ title?: string; nm?: number; subjectId?: number; }[]>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.createSupplierNm({});
console.log(result);

getAdvDelete()

getAdvDelete(options?: {
  id: number;
}): Promise<unknown>;

Defined in: modules/promotion/index.ts:197

Удаление кампании

Метод удаляет кампании в статусе 4 — готова к запуску.<br><br> После удаления кампания некоторое время будет находиться в статусе -1 — кампания в процессе удаления. Полное удаление кампании занимает от 3 до 10 минут. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 5 запросов | 200 миллисекунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `id`: `number`; }	Query parameters
`options.id?`	`number`	-

Returns

Promise<unknown>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getAdvDelete({});
console.log(result);

createAdvRename()

createAdvRename(data?: {
  advertId: number;
  name: string;
}): Promise<unknown>;

Defined in: modules/promotion/index.ts:216

Переименование кампании

Метод меняет название кампании. Это можно сделать в любой момент существования кампании. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 5 запросов | 200 миллисекунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`data?`	{ `advertId`: `number`; `name`: `string`; }	Request body data
`data.advertId?`	`number`	-
`data.name?`	`string`	-

Returns

Promise<unknown>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.createAdvRename({});
console.log(result);

getAdvStart()

getAdvStart(options?: {
  id: number;
}): Promise<unknown>;

Defined in: modules/promotion/index.ts:235

Запуск кампании

Метод запускает кампании в статусах 4 — готово к запуску — или 11 — пауза. Чтобы запустить кампанию со статусом 4, необходимо выполнить два условия: 1. После создания кампании в кабинете WB. Продвижение нажать кнопку Применить изменения. 2. Установить бюджет — максимальную сумму затрат на кампанию. Чтобы запустить кампанию со статусом 11, проверьте ее бюджет. Если бюджета недостаточно, пополните его. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 5 запросов | 200 миллисекунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `id`: `number`; }	Query parameters
`options.id?`	`number`	-

Returns

Promise<unknown>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getAdvStart({});
console.log(result);

getAdvPause()

getAdvPause(options?: {
  id: number;
}): Promise<unknown>;

Defined in: modules/promotion/index.ts:254

Пауза кампании

Метод ставит кампании в статусе 9 — активна — на паузу. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 5 запросов | 200 миллисекунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `id`: `number`; }	Query parameters
`options.id?`	`number`	-

Returns

Promise<unknown>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getAdvPause({});
console.log(result);

getAdvStop()

getAdvStop(options?: {
  id: number;
}): Promise<unknown>;

Defined in: modules/promotion/index.ts:273

Завершение кампании

Метод завершает кампании в статусах: - 4 — готово к запуску - 9 — активна - 11 — пауза <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 5 запросов | 200 миллисекунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `id`: `number`; }	Query parameters
`options.id?`	`number`	-

Returns

Promise<unknown>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getAdvStop({});
console.log(result);

updateAdvBid()

updateAdvBid(data: {
  bids: V0AdvertMultibid[];
}): Promise<void>;

Defined in: modules/promotion/index.ts:291

Изменение ставок

Метод меняет ставки карточек товаров по артикулам WB в кампаниях с единой ставкой. <br><br> Для кампаний в статусах 4, 9 и 11. <br><br> Для изменения ставок в кампаниях с ручной ставкой используйте отдельный метод. <br><br> Минимально допустимые ставки вы можете получить в ответе метода получения минимальных ставок для карточек товаров. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 5 запросов | 200 миллисекунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`data`	{ `bids`: `V0AdvertMultibid`[]; }	Request body data
`data.bids`	`V0AdvertMultibid`[]	-

Returns

Promise<void>

Response data

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.updateAdvBid({});

updateAuctionPlacement()

updateAuctionPlacement(data: {
  placements: {
     advert_id: number;
     placements: {
        search: boolean;
        recommendations: boolean;
     };
  }[];
}): Promise<void>;

Defined in: modules/promotion/index.ts:309

Изменение мест размещения в кампаниях с ручной ставкой

Метод меняет места размещения в кампаниях с ручной ставкой. <br><br> Для кампаний в статусах 4, 9 и 11. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 1 запрос | 1 секунда | 1 запрос | </div>

Parameters

Parameter	Type	Description
`data`	{ `placements`: { `advert_id`: `number`; `placements`: { `search`: `boolean`; `recommendations`: `boolean`; }; }[]; }	Request body data
`data.placements`	{ `advert_id`: `number`; `placements`: { `search`: `boolean`; `recommendations`: `boolean`; }; }[]	-

Returns

Promise<void>

Response data

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.updateAuctionPlacement({});

updateAuctionBid()

updateAuctionBid(data: {
  bids: {
     advert_id: number;
     nm_bids: {
        nm_id: number;
        bid: number;
        placement: "combined" | "search" | "recommendations";
     }[];
  }[];
}): Promise<{
  bids: {
     advert_id: number;
     nm_bids: {
        nm_id: number;
        bid: number;
        placement: string;
     }[];
  }[];
}>;

Defined in: modules/promotion/index.ts:328

Изменение ставок в кампаниях

Метод меняет ставки карточек товаров по артикулам WB в кампаниях типа 9 с единой или ручной ставкой. <br><br> Для кампаний в статусах 4, 9 и 11. <br><br> В запросе укажите место размещения в параметре placement: - combined — в поиске и рекомендациях для кампаний с единой ставкой - search или recommendations — в поиске или рекомендациях для кампаний с ручной ставкой <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 5 запросов | 200 миллисекунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`data`	{ `bids`: { `advert_id`: `number`; `nm_bids`: { `nm_id`: `number`; `bid`: `number`; `placement`: `"combined"` \| `"search"` \| `"recommendations"`; }[]; }[]; }	Request body data
`data.bids`	{ `advert_id`: `number`; `nm_bids`: { `nm_id`: `number`; `bid`: `number`; `placement`: `"combined"` \| `"search"` \| `"recommendations"`; }[]; }[]	-

Returns

Promise<{ bids: { advert_id: number; nm_bids: { nm_id: number; bid: number; placement: string; }[]; }[]; }>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.updateAuctionBid({});
console.log(result);

getAdvBalance()

getAdvBalance(): Promise<{
  balance?: number;
  net?: number;
  bonus?: number;
  cashbacks?: {
     sum?: number;
     percent?: number;
     expiration_date?: string;
  }[];
}>;

Defined in: modules/promotion/index.ts:346

Баланс

Метод возвращает информацию о: - счёте кабинета Продвижения WB. Его пополняет продавец. - балансе — максимальной сумме для оплаты камапнии по взаиморасчету: удержании средств из будущих продаж. Баланс пополнить нельзя, он рассчитывается автоматически на основе отчётов по продвижению. - бонусных начислениях WB. Информацию о бюджете кампаний можно получить в отдельном методе. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 1 запрос | 1 секунда | 5 запросов | </div>

Returns

Promise<{ balance?: number; net?: number; bonus?: number; cashbacks?: { sum?: number; percent?: number; expiration_date?: string; }[]; }>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getAdvBalance();
console.log(result);

getAdvBudget()

getAdvBudget(options?: {
  id: number;
}): Promise<{
  cash?: number;
  netting?: number;
  total?: number;
}>;

Defined in: modules/promotion/index.ts:365

Бюджет кампании

Метод возвращает информацию о бюджете кампании — максимальной сумме затрат на кампанию. Бюджет кампании можно пополнить. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 4 запроса | 250 миллисекунд | 4 запроса | </div>

Parameters

Parameter	Type	Description
`options?`	{ `id`: `number`; }	Query parameters
`options.id?`	`number`	-

Returns

Promise<{ cash?: number; netting?: number; total?: number; }>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getAdvBudget({});
console.log(result);

createBudgetDeposit()

createBudgetDeposit(data: {
  sum?: number;
  cashback_sum?: number;
  cashback_percent?: number;
  type?: number;
  return?: boolean;
}, options?: {
  id: number;
}): Promise<ResponseWithReturn>;

Defined in: modules/promotion/index.ts:385

Пополнение бюджета кампании

Метод пополняет бюджет кампании в статусе 11 — на паузе. <br> Чтобы запустить кампанию после пополнения бюджета, используйте метод Запуск кампании. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 1 запрос | 1 секунда | 5 запросов | </div>

Parameters

Parameter	Type	Description
`data`	{ `sum?`: `number`; `cashback_sum?`: `number`; `cashback_percent?`: `number`; `type?`: `number`; `return?`: `boolean`; }	Request body data
`data.sum?`	`number`	-
`data.cashback_sum?`	`number`	-
`data.cashback_percent?`	`number`	-
`data.type?`	`number`	-
`data.return?`	`boolean`	-
`options?`	{ `id`: `number`; }	Query parameters
`options.id?`	`number`	-

Returns

Promise<ResponseWithReturn>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.createBudgetDeposit({}, {});
console.log(result);

getAdvUpd()

getAdvUpd(options?: {
  from: string;
  to: string;
}): Promise<{
  updNum?: number;
  updTime?: string;
  updSum?: number;
  advertId?: number;
  campName?: string;
  advertType?: number;
  paymentType?: string;
  advertStatus?: number;
}[]>;

Defined in: modules/promotion/index.ts:404

Получение истории затрат

Метод формирует список фактических затрат на рекламные кампании за заданный период. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 1 запрос | 1 секунда | 5 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `from`: `string`; `to`: `string`; }	Query parameters
`options.from?`	`string`	-
`options.to?`	`string`	-

Returns

Promise<{ updNum?: number; updTime?: string; updSum?: number; advertId?: number; campName?: string; advertType?: number; paymentType?: string; advertStatus?: number; }[]>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getAdvUpd({});
console.log(result);

getAdvPayments()

getAdvPayments(options?: {
  from?: string;
  to?: string;
}): Promise<{
  id?: number;
  date?: string;
  sum?: number;
  type?: number;
  statusId?: number;
  cardStatus?: string;
}[]>;

Defined in: modules/promotion/index.ts:423

Получение истории пополнений счёта

Метод возвращает историю пополнений счёта WB Продвижение за заданный период. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 1 запрос | 1 секунда | 5 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `from?`: `string`; `to?`: `string`; }	Query parameters
`options.from?`	`string`	-
`options.to?`	`string`	-

Returns

Promise<{ id?: number; date?: string; sum?: number; type?: number; statusId?: number; cardStatus?: string; }[]>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getAdvPayments({});
console.log(result);

getSearchSetPlus()

getSearchSetPlus(options?: {
  id: number;
  fixed?: boolean;
}): Promise<unknown>;

Defined in: modules/promotion/index.ts:442

Управление активностью фиксированных фраз

Метод делает активными или неактивными фиксированные фразы в кампаниях с ручной ставкой. Фиксированные фразы нужны, чтобы товар отображался в поиске только по определенным поисковым запросам.<br><br> Установить или удалить фиксированные фразы можно через отдельный метод. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 500 миллисекунд | 1 запрос | 500 миллисекунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `id`: `number`; `fixed?`: `boolean`; }	Query parameters
`options.id?`	`number`	-
`options.fixed?`	`boolean`	-

Returns

Promise<unknown>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getSearchSetPlus({});
console.log(result);

createSearchSetPlu()

createSearchSetPlu(data: {
  pluse?: string[];
}, options?: {
  id: number;
}): Promise<string[]>;

Defined in: modules/promotion/index.ts:462

Установка/удаление фиксированных фраз

Метод устанавливает и удаляет фиксированные фразы в кампаниях с ручной ставкой. Фиксированные фразы можно выбрать в списке ключевых фраз кампании, который формируется после запуска.<br><br> Отправка пустого массива в методе удаляет все фиксированные фразы и отключает активность всех фиксированных фраз кампании. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 500 миллисекунд | 1 запрос | 500 миллисекунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`data`	{ `pluse?`: `string`[]; }	Request body data
`data.pluse?`	`string`[]	-
`options?`	{ `id`: `number`; }	Query parameters
`options.id?`	`number`	-

Returns

Promise<string[]>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.createSearchSetPlu({}, {});
console.log(result);

createSearchSetExcluded()

createSearchSetExcluded(data: {
  excluded?: string[];
}, options?: {
  id: number;
}): Promise<unknown>;

Defined in: modules/promotion/index.ts:482

Установка/удаление минус-фраз в поиске

Метод устанавливает и удаляет минус-фразы в поиске, в кампаниях с ручной ставкой.<br><br> Данные фразы можно выбрать из списка запросов, по которым покупатели находили ваш товар. Список запросов можно получить в статистике ключевых фраз.<br>Максимально допустимое количество минус-фраз в кампании — 1000.<br> Отправка пустого массива удаляет все минус-фразы из поиска из кампании. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 2 запроса | 500 миллисекунд | 2 запроса | </div>

Parameters

Parameter	Type	Description
`data`	{ `excluded?`: `string`[]; }	Request body data
`data.excluded?`	`string`[]	-
`options?`	{ `id`: `number`; }	Query parameters
`options.id?`	`number`	-

Returns

Promise<unknown>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.createSearchSetExcluded({}, {});
console.log(result);

createAutoSetExcluded()

createAutoSetExcluded(data: {
  excluded?: string[];
}, options?: {
  id: number;
}): Promise<unknown>;

Defined in: modules/promotion/index.ts:502

Установка/удаление минус-фраз для кампании с единой ставкой

<div class="description_important"> ⚠️ DEPRECATED: Этот метод устарел и будет отключён 2 февраля 2026.<br><br> Обновление: Дата отключения перенесена с 15 января на 2 февраля 2026.<br><br> Причина: Переход от кампаний с единой ставкой (type 8) к кампаниям с ручной и единой ставкой (type 9).<br><br> Альтернатива: Для работы с минус-фразами в кампаниях type 9 используйте соответствующие методы управления кампаниями с ручной ставкой. </div> Метод устанавливает и удаляет минус-фразы для кампании с единой ставкой.<br><br> Данные фразы можно выбрать из списка запросов, по которым покупатели находили ваш товар. Список запросов можно получить в статистике ключевых фраз.<br> Отправка пустого массива удаляет все минус-фразы из кампании. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 6 секунд | 1 запрос | 6 секунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`data`	{ `excluded?`: `string`[]; }	Request body data
`data.excluded?`	`string`[]	-
`options?`	{ `id`: `number`; }	Query parameters
`options.id?`	`number`	-

Returns

Promise<unknown>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.createAutoSetExcluded({}, {});
console.log(result);

getAutoGetnmtoadd()

getAutoGetnmtoadd(options?: {
  id: number;
}): Promise<number[]>;

Defined in: modules/promotion/index.ts:521

Список карточек товаров для кампании с единой ставкой

Parameters

Parameter	Type	Description
`options?`	{ `id`: `number`; }	Query parameters
`options.id?`	`number`	-

Returns

Promise<number[]>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getAutoGetnmtoadd({});
console.log(result);

createAutoUpdatenm()

createAutoUpdatenm(data: {
  add?: number[];
  delete?: number[];
}, options?: {
  id: number;
}): Promise<unknown>;

Defined in: modules/promotion/index.ts:541

Изменение списка карточек товаров в кампании с единой ставкой

<div class="description_important"> ⚠️ DEPRECATED: Этот метод устарел и будет отключён 2 февраля 2026.<br><br> Причина: Переход от кампаний с единой ставкой (type 8) к кампаниям с ручной и единой ставкой (type 9).<br><br> Альтернатива: Для работы с товарами в кампаниях type 9 используйте метод Управление товарами в кампаниях. </div> Метод добавляет и удаляет карточки товаров в кампании с единой ставкой.<br><br> <div class="description_important"> Добавить можно только те карточки товаров, которые вернутся в <a href="/openapi/promotion#tag/Parametry-avtomaticheskih-kampanij/paths/~1adv~1v1~1auto~1getnmtoadd/get">списке карточек товаров для кампании с единой ставкой</a>.<br>Удалить единственную карточку товара из кампании нельзя. </div> Проверки по параметру delete не предусмотрено. Если пришел ответ со статус-кодом 200, а изменений не произошло, проверьте, чтобы запрос соответствовал документации. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 60 запросов | 1 секунда | 5 запросов | </div>

Parameters

Parameter	Type	Description
`data`	{ `add?`: `number`[]; `delete?`: `number`[]; }	Request body data
`data.add?`	`number`[]	-
`data.delete?`	`number`[]	-
`options?`	{ `id`: `number`; }	Query parameters
`options.id?`	`number`	-

Returns

Promise<unknown>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.createAutoUpdatenm({}, {});
console.log(result);

updateAuctionNm()

updateAuctionNm(data: {
  nms: {
     advert_id: number;
     nms: {
        add?: unknown;
        delete?: number[];
     };
  }[];
}): Promise<{
  nms: {
     advert_id: number;
     nms: {
        added: number[];
        deleted: number[];
     };
  }[];
}>;

Defined in: modules/promotion/index.ts:560

Изменение списка карточек товаров в кампаниях

Метод добавляет и удаляет карточки товаров в кампаниях. <br><br> Для кампаний в статусах 4, 9 и 11. <br><br> Для добавляемых товаров устанавливается текущая минимальная ставка. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 1 запрос | 1 секунда | 1 запрос | </div>

Parameters

Parameter	Type	Description
`data`	{ `nms`: { `advert_id`: `number`; `nms`: { `add?`: `unknown`; `delete?`: `number`[]; }; }[]; }	Request body data
`data.nms`	{ `advert_id`: `number`; `nms`: { `add?`: `unknown`; `delete?`: `number`[]; }; }[]	-

Returns

Promise<{ nms: { advert_id: number; nms: { added: number[]; deleted: number[]; }; }[]; }>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.updateAuctionNm({});
console.log(result);

getAdvCount()

getAdvCount(): Promise<{
  all?: number;
  adverts?: {
     type?: number;
     status?: number;
     count?: number;
  };
}>;

Defined in: modules/promotion/index.ts:578

Количество медиакампаний

Метод возвращает количество медиакампаний продавца с группировкой по статусам. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 10 запросов | 100 миллисекунд | 10 запросов | </div>

Returns

Promise<{ all?: number; adverts?: { type?: number; status?: number; count?: number; }; }>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getAdvCount();
console.log(result);

getAdvAdverts()

getAdvAdverts(options?: {
  status?: number;
  type?: number;
  limit?: number;
  offset?: number;
  order?: string;
  direction?: string;
}): Promise<{
  advertId?: number;
  name?: string;
  brand?: string;
  type?: number;
  status?: number;
  createTime?: string;
  endTime?: string;
}[]>;

Defined in: modules/promotion/index.ts:597

Список медиакампаний

Метод возвращает список всех медиакампаний продавца по их типам и статусам. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 10 запросов | 100 миллисекунд | 10 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `status?`: `number`; `type?`: `number`; `limit?`: `number`; `offset?`: `number`; `order?`: `string`; `direction?`: `string`; }	Query parameters
`options.status?`	`number`	-
`options.type?`	`number`	-
`options.limit?`	`number`	-
`options.offset?`	`number`	-
`options.order?`	`string`	-
`options.direction?`	`string`	-

Returns

Promise<{ advertId?: number; name?: string; brand?: string; type?: number; status?: number; createTime?: string; endTime?: string; }[]>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getAdvAdverts({});
console.log(result);

getAdvAdvert()

getAdvAdvert(options?: {
  id: number;
}): Promise<{
  advertId?: number;
  name?: string;
  brand?: string;
  type?: number;
  status?: number;
  createTime?: string;
  extended?: {
     reason?: string;
     expenses?: number;
     from?: string;
     to?: string;
     updated_at?: string;
     price?: number;
     budget?: number;
     operation?: number;
     contract_id?: number;
  };
  items?: {
     id?: number;
     name?: string;
     status?: number;
     place?: number;
     budget?: number;
     daily_limit?: number;
     category_name?: string;
     cpm?: number;
     url?: string;
     advert_type?: number;
     created_at?: string;
     updated_at?: string;
     date_from?: string;
     date_to?: string;
     nms?: number[];
     bottomText1?: string;
     bottomText2?: string;
     message?: string;
     additionalSettings?: number;
     receiversCount?: number;
     subject_id?: number;
     subject_name?: string;
     action_name?: string;
     show_hours?: {
        From?: number;
        To?: number;
     }[];
     Erid?: string;
  }[];
}>;

Defined in: modules/promotion/index.ts:616

Информация о медиакампании

Метод возвращает информацию о кампании WB Медиа. Вместо карточек товаров в медиакампаниях продвигаются рекламные баннеры продавца на сайте и в приложении WB. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 10 запросов | 100 миллисекунд | 10 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `id`: `number`; }	Query parameters
`options.id?`	`number`	-

Returns

Promise<{ advertId?: number; name?: string; brand?: string; type?: number; status?: number; createTime?: string; extended?: { reason?: string; expenses?: number; from?: string; to?: string; updated_at?: string; price?: number; budget?: number; operation?: number; contract_id?: number; }; items?: { id?: number; name?: string; status?: number; place?: number; budget?: number; daily_limit?: number; category_name?: string; cpm?: number; url?: string; advert_type?: number; created_at?: string; updated_at?: string; date_from?: string; date_to?: string; nms?: number[]; bottomText1?: string; bottomText2?: string; message?: string; additionalSettings?: number; receiversCount?: number; subject_id?: number; subject_name?: string; action_name?: string; show_hours?: { From?: number; To?: number; }[]; Erid?: string; }[]; }>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getAdvAdvert({});
console.log(result);

createAdvFullstat()

createAdvFullstat(data: 
  | RequestWithDate
  | RequestWithInterval
  | RequestWithCampaignID[]): Promise<
  | ResponseWithDate
| ResponseWithInterval>;

Defined in: modules/promotion/index.ts:635

Статистика кампаний

Метод будет отключён 30 сентября. Используйте актуальный метод. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 1 запрос | 1 минута | 5 запросов | </div>

Parameters

Parameter	Type	Description
`data`	\| `RequestWithDate` \| `RequestWithInterval` \| `RequestWithCampaignID`[]	Request body data

Returns

Promise< | ResponseWithDate | ResponseWithInterval>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.createAdvFullstat({});
console.log(result);

getAdvFullstats()

getAdvFullstats(options?: {
  ids: string;
  beginDate: string;
  endDate: string;
}): Promise<ResponseFullStats>;

Defined in: modules/promotion/index.ts:654

Статистика кампаний

Метод формирует статистику для кампаний независимо от типа. <br><br> Максимальный период в запросе — 31 день. <br><br> Для кампаний в статусах 7, 9 и 11. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 3 запроса | 20 секунд | 1 запрос | </div>

Parameters

Parameter	Type	Description
`options?`	{ `ids`: `string`; `beginDate`: `string`; `endDate`: `string`; }	Query parameters
`options.ids?`	`string`	-
`options.beginDate?`	`string`	-
`options.endDate?`	`string`	-

Returns

Promise<ResponseFullStats>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getAdvFullstats({});
console.log(result);

getAutoStatWords()

getAutoStatWords(options?: {
  id: number;
}): Promise<{
  excluded?: string[];
  clusters?: {
     cluster?: string;
     count?: number;
     keywords?: string[];
  }[];
}>;

Defined in: modules/promotion/index.ts:673

Статистика кампании с единой ставкой по кластерам фраз

<div class="description_important"> ⚠️ DEPRECATED: Этот метод устарел и будет отключён 2 февраля 2026.<br><br> Причина: Переход от кампаний с единой ставкой (type 8) к кампаниям с ручной и единой ставкой (type 9).<br><br> Альтернатива: Для получения статистики всех типов кампаний (включая type 9) используйте универсальный метод Полная статистика кампаний. Он предоставляет более подробную статистику для всех типов кампаний. </div> Метод формирует кластеры ключевых — то есть, наборы похожих — фраз из поисковой строки, если по ним хотя бы один раз были показаны товары из кампании. В ответе метода также указано количество показов этих товаров. <br><br> Информация обновляется каждые 15 минут. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 4 запроса | 250 миллисекунд | 4 запроса | </div>

Parameters

Parameter	Type	Description
`options?`	{ `id`: `number`; }	Query parameters
`options.id?`	`number`	-

Returns

Promise<{ excluded?: string[]; clusters?: { cluster?: string; count?: number; keywords?: string[]; }[]; }>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getAutoStatWords({});
console.log(result);

getStatWords()

getStatWords(options?: {
  id: number;
}): Promise<{
  words?: {
     phrase?: string[];
     strong?: string[];
     excluded?: string[];
     pluse?: string[];
     keywords?: {
        keyword?: string;
        count?: number;
     }[];
     fixed?: boolean;
  };
  stat?: {
     advertId?: number;
     keyword?: string;
     advertName?: string;
     campaignName?: string;
     begin?: string;
     end?: string;
     views?: number;
     clicks?: number;
     frq?: number;
     ctr?: number;
     cpc?: number;
     duration?: number;
     sum?: number;
  }[];
}>;

Defined in: modules/promotion/index.ts:692

Статистика кампании c ручной ставкой по ключевым фразам

Метод формирует статистику кампании c ручной ставкой по ключевым фразам из поисковой строки: количество просмотров товара и затраты по одной ключевой фразе. <br><br> Информация обновляется каждые 30 минут. <div class="description_important"> Тип рекламных кампаний <strong>Поиск</strong> устарел. </div> <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 4 запроса | 250 миллисекунд | 4 запроса | </div>

Parameters

Parameter	Type	Description
`options?`	{ `id`: `number`; }	Query parameters
`options.id?`	`number`	-

Returns

Promise<{ words?: { phrase?: string[]; strong?: string[]; excluded?: string[]; pluse?: string[]; keywords?: { keyword?: string; count?: number; }[]; fixed?: boolean; }; stat?: { advertId?: number; keyword?: string; advertName?: string; campaignName?: string; begin?: string; end?: string; views?: number; clicks?: number; frq?: number; ctr?: number; cpc?: number; duration?: number; sum?: number; }[]; }>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getStatWords({});
console.log(result);

getStatsKeywords()

getStatsKeywords(options?: {
  advert_id: number;
  from: string;
  to: string;
}): Promise<V0KeywordsStatisticsResponse>;

Defined in: modules/promotion/index.ts:711

Статистика по ключевым фразам

Метод формирует статистику по ключевым фразам из поисковой строки: количество просмотров товара и затраты по одной ключевой фразе. Подходит для кампаний c единой и ручной ставкой. <br><br> Статистика формируется за каждый день, когда кампания была активна. В одном запросе можно получить данные максимум за 7 дней. <br> Данные обновляются каждый час. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 4 запроса | 250 миллисекунд | 4 запроса | </div>

Parameters

Parameter	Type	Description
`options?`	{ `advert_id`: `number`; `from`: `string`; `to`: `string`; }	Query parameters
`options.advert_id?`	`number`	-
`options.from?`	`string`	-
`options.to?`	`string`	-

Returns

Promise<V0KeywordsStatisticsResponse>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getStatsKeywords({});
console.log(result);

createAdvStat()

createAdvStat(data: 
  | RequestWithDate
  | RequestWithInterval
  | RequestWithCampaignID[]): Promise<
  | StatInterval
  | StatDate
| Stat[]>;

Defined in: modules/promotion/index.ts:730

Статистика медиакампаний

Метод формирует статистику кампаний сервиса WB Медиа. Статистику можно группировать по датам и/или интервалам. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 секунда | 10 запросов | 100 миллисекунд | 10 запросов | </div>

Parameters

Parameter	Type	Description
`data`	\| `RequestWithDate` \| `RequestWithInterval` \| `RequestWithCampaignID`[]	Request body data

Returns

Promise< | StatInterval | StatDate | Stat[]>

Успешно

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.createAdvStat({});
console.log(result);

getCalendarPromotions()

getCalendarPromotions(options?: {
  startDateTime: string;
  endDateTime: string;
  allPromo: boolean;
  limit?: number;
  offset?: number;
}): Promise<unknown>;

Defined in: modules/promotion/index.ts:749

Список акций

Метод возвращает список акций в WB с датами и временем проведения. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца для всех методов категории <strong>Календарь акций</strong>: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 6 секунд | 10 запросов | 600 миллисекунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `startDateTime`: `string`; `endDateTime`: `string`; `allPromo`: `boolean`; `limit?`: `number`; `offset?`: `number`; }	Query parameters
`options.startDateTime?`	`string`	-
`options.endDateTime?`	`string`	-
`options.allPromo?`	`boolean`	-
`options.limit?`	`number`	-
`options.offset?`	`number`	-

Returns

Promise<unknown>

Response data

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getCalendarPromotions({});
console.log(result);

getPromotionsDetails()

getPromotionsDetails(options?: {
  promotionIDs: string;
}): Promise<unknown>;

Defined in: modules/promotion/index.ts:768

Детальная информация об акциях

Метод возвращает подробную информацию об акции по ID. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца для всех методов категории <strong>Календарь акций</strong>: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 6 секунд | 10 запросов | 600 миллисекунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `promotionIDs`: `string`; }	Query parameters
`options.promotionIDs?`	`string`	-

Returns

Promise<unknown>

Response data

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getPromotionsDetails({});
console.log(result);

getPromotionsNomenclatures()

getPromotionsNomenclatures(options?: {
  promotionID: number;
  inAction: boolean;
  limit?: number;
  offset?: number;
}): Promise<unknown>;

Defined in: modules/promotion/index.ts:787

Список товаров для участия в акции

Метод формирует список товаров, подходящих для участия в акции. Эти товары можно добавить в акцию с помощью отдельного метода. <div class="description_important"> Данный метод неприменим для автоакций. </div> <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца для всех методов категории <strong>Календарь акций</strong>: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 6 секунд | 10 запросов | 600 миллисекунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `promotionID`: `number`; `inAction`: `boolean`; `limit?`: `number`; `offset?`: `number`; }	Query parameters
`options.promotionID?`	`number`	-
`options.inAction?`	`boolean`	-
`options.limit?`	`number`	-
`options.offset?`	`number`	-

Returns

Promise<unknown>

Response data

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.getPromotionsNomenclatures({});
console.log(result);

createPromotionsUpload()

createPromotionsUpload(): Promise<unknown>;

Defined in: modules/promotion/index.ts:805

Добавить товар в акцию

Метод создаёт задание на загрузку товара в акцию.<br> Состояние загрузки можно проверить с помощью отдельных методов. <div class="description_important"> Данный метод неприменим для автоакций. </div> <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца для всех методов категории <strong>Календарь акций</strong>: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 6 секунд | 10 запросов | 600 миллисекунд | 5 запросов | </div>

Returns

Promise<unknown>

Response data

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.general.createPromotionsUpload();
console.log(result);

Class: PromotionModule ​

Constructors ​

Constructor ​

Parameters ​

Returns ​

Methods ​

getPromotionCount() ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

createPromotionAdvert() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

getAuctionAdverts() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

getAdvConfig() ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

createBidsMin() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

createAdvSaveAd() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

createSeacatSaveAd() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

getSupplierSubjects() ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

createSupplierNm() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

getAdvDelete() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Class: PromotionModule

Constructors

Constructor

Parameters

Returns

Methods

getPromotionCount()

Returns

Throws

Throws

Throws

Throws

Example

createPromotionAdvert()

Parameters

Returns

Throws

Throws

Throws

Throws

Example

getAuctionAdverts()

Parameters

Returns

Throws

Throws

Throws

Throws

Example

getAdvConfig()

Returns

Throws

Throws

Throws

Throws

Example

createBidsMin()

Parameters

Returns

Throws

Throws

Throws

Throws

Example

createAdvSaveAd()

Parameters

Returns

Throws

Throws

Throws

Throws

Example

createSeacatSaveAd()

Parameters

Returns

Throws

Throws

Throws

Throws

Example

getSupplierSubjects()

Returns

Throws

Throws

Throws

Throws

Example

createSupplierNm()

Parameters

Returns

Throws

Throws

Throws

Throws

Example

getAdvDelete()

Parameters

Returns

Throws

Throws