Поиск

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

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

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

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

Данные синхронизируются с базой раз в 3 минуты. Статусы кампаний меняются раз в минуту. Ставки кампаний меняются раз в 30 секунд.

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

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

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

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

Данные синхронизируются с базой раз в 3 минуты. Статусы кампаний меняются раз в минуту. Ставки кампаний меняются раз в 30 секунд.

Кампании

Для доступа к методам используйте токен для категории Продвижение

Методы получения:

Списки кампаний{{ /adv/v1/promotion/count }}

Описание метода

Метод возвращает списки всех рекламных кампаний продавца с их ID. Кампании сгруппированы по типу и статусу, у каждой указана дата последнего изменения.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 сек 5 запросов 200 мс 5 запросов
Сервисный 1 сек 5 запросов 200 мс 5 запросов
Базовый с секретом 1 сек 5 запросов 200 мс 5 запросов
Базовый 1 ч 4 запроса 15 мин 1 запрос
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "adverts": [
    ],
  • "all": 3
}

Информация о кампаниях{{ /api/advert/v2/adverts }}

Описание метода

Метод возвращает информацию о рекламных кампаниях с единой или ручной ставкой по их статусам, типам оплаты и ID.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 сек 5 запросов 200 мс 5 запросов
Сервисный 1 сек 5 запросов 200 мс 5 запросов
Базовый с секретом 1 сек 5 запросов 200 мс 5 запросов
Базовый 1 ч 1 запрос 1 ч 1 запрос
Authorizations:
HeaderApiKey
query Parameters
ids
string
Example: ids=12345,23456,34567,45678,56789

ID кампаний, максимум 50

statuses
string
Example: statuses=-1,4,8

Статусы кампаний:

  • -1 — удалена, процесс удаления будет завершён в течение 10 минут
  • 4 — готова к запуску
  • 7 — завершена
  • 8 — отменена
  • 9 — активна
  • 11 — на паузе
payment_type
string
Enum: cpm cpc

Тип оплаты:

  • cpm — за показы
  • cpc — за клик

Responses

Response samples

Content type
application/json
{
  • "adverts": [
    ]
}

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

Для доступа к методам используйте токен для категории Продвижение

Метод создания кампаний с единой или ручной ставкой, а также получения:

  1. Минимальных ставок для карточек товаров
  2. Предметов для кампаний
  3. Карточек товаров для кампаний

Минимальные ставки для карточек товаров{{ /api/advert/v1/bids/min }}

Описание метода

Метод возвращает минимальные ставки для карточек товаров в разменных единицах — 0,01 от базовой валюты профиля продавца — по типу оплаты и местам размещения.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 20 запросов 3 сек 5 запросов
Сервисный 1 мин 20 запросов 3 сек 5 запросов
Базовый с секретом 1 мин 20 запросов 3 сек 5 запросов
Базовый 1 ч 5 запросов 12 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
advert_id
required
integer <int64>

ID кампании

nm_ids
required
Array of integers <int64> [ 1 .. 100 ] characters [ items <int64 > ]

Список артикулов WB

payment_type
required
string
Enum: cpm cpc

Тип оплаты: - cpm — за показы - cpc — за клик

placement_types
required
Array of strings
Items Enum: combined search recommendation

Места размещения:

  • search — поиск
  • recommendation — рекомендации
  • combined — поиск и рекомендации

Responses

Request samples

Content type
application/json
{
  • "advert_id": 98765432,
  • "nm_ids": [
    ],
  • "payment_type": "cpm",
  • "placement_types": [
    ]
}

Response samples

Content type
application/json
{
  • "bids": [
    ]
}

Создать кампанию{{ /adv/v2/seacat/save-ad }}

Описание метода

Метод создаёт кампанию:

  • с ручной ставкой для продвижения товаров в поиске и/или рекомендациях
  • с единой ставкой для продвижения товаров одновременно в поиске и рекомендациях
Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 5 запросов 12 сек 5 запросов
Сервисный 1 мин 5 запросов 12 сек 5 запросов
Базовый с секретом 1 мин 5 запросов 12 сек 5 запросов
Базовый 1 ч 5 запросов 12 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
name
required
string

Название кампании

nms
Array of integers

Карточки товаров для кампании. Доступные карточки товаров можно получить с помощью метода Карточки товаров для кампаний. Максимум 50 товаров (nm)

bid_type
string
Default: manual
Enum: manual unified

Тип ставки:

  • manual — ручная
  • unified — единая
payment_type
string
Default: cpm
Enum: cpm cpc

Тип оплаты:

  • cpm — за показы
  • cpc — за клик. При создании с этим типом оплаты в кампании автоматически устанавливается минимальная ставка
placement_types
Array of strings
Default: search
Items Enum: search recommendations

Места размещения:

  • search — в поиске
  • recommendations — в рекомендациях

Укажите только для кампании с ручной ставкой

Responses

Request samples

Content type
application/json
{
  • "name": "Телефоны",
  • "nms": [
    ],
  • "bid_type": "manual",
  • "placement_types": [
    ]
}

Response samples

Content type
application/json
1234567

Предметы для кампаний{{ /adv/v1/supplier/subjects }}

Описание метода

Метод возвращает список предметов, которые можно добавить в рекламную кампанию.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 12 сек 1 запрос 12 сек 5 запросов
Сервисный 12 сек 1 запрос 12 сек 5 запросов
Базовый с секретом 12 сек 1 запрос 12 сек 5 запросов
Базовый 1 ч 2 запроса 30 мин 1 запрос
Authorizations:
HeaderApiKey
query Parameters
payment_type
string
Default: cpm

Тип оплаты:

  • cpm — за показы
  • cpc — за клик

Responses

Response samples

Content type
application/json
Example
[
  • {
    }
]

Карточки товаров для кампаний{{ /adv/v2/supplier/nms }}

Описание метода

Метод возвращает список карточек товаров, которые можно добавить в рекламную кампанию. Для получения карточек необходимы ID предметов, также доступных для добавления в кампанию.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 5 запросов 12 сек 5 запросов
Сервисный 1 мин 5 запросов 12 сек 5 запросов
Базовый с секретом 1 мин 5 запросов 12 сек 5 запросов
Базовый 1 ч 2 запроса 30 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json

ID предметов, для которых нужно получить карточки товаров

Array
integer

Responses

Request samples

Content type
application/json
[
  • 123,
  • 456,
  • 765,
  • 321
]

Response samples

Content type
application/json
[
  • {
    }
]

Управление кампаниями

Для доступа к методам используйте токен для категории Продвижение

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

  1. Удалить кампанию
  2. Переименовать кампанию
  3. Запустить кампанию
  4. Поставить кампанию на паузу
  5. Завершить кампанию
  6. Получить список рекомендуемых ставок
  7. Получить конфигурационные значения продвижения
  8. Изменить ставки в кампаниях
  9. Изменить список карточек товаров в кампаниях
  10. Изменить места размещения в кампаниях с ручной ставкой

Удаление кампании{{ /adv/v0/delete }}

Описание метода

Метод удаляет кампании в статусе 4 — готова к запуску.

После удаления кампания некоторое время будет находиться в статусе -1 — кампания в процессе удаления. Полное удаление кампании занимает от 3 до 10 минут.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 сек 5 запросов 200 мс 5 запросов
Сервисный 1 сек 5 запросов 200 мс 5 запросов
Базовый с секретом 1 сек 5 запросов 200 мс 5 запросов
Базовый 1 ч 5 запросов 12 мин 1 запрос
Authorizations:
HeaderApiKey
query Parameters
id
required
integer

ID кампании

Responses

Response samples

Content type
application/json

Некорректный ID кампании

{
  • "error": "Некорректный ID кампании"
}

Переименование кампании{{ /adv/v0/rename }}

Описание метода

Метод меняет название кампании. Это можно сделать в любой момент существования кампании.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 сек 5 запросов 200 мс 5 запросов
Сервисный 1 сек 5 запросов 200 мс 5 запросов
Базовый с секретом 1 сек 5 запросов 200 мс 5 запросов
Базовый 1 ч 2 запроса 30 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
advertId
required
integer

ID кампании, в которой меняется название

name
required
string

Новое название (максимум 100 символов)

Responses

Request samples

Content type
application/json
{
  • "advertId": 2233344,
  • "name": "newname"
}

Response samples

Content type
text/plain
Example
Некорректный ID РК

Запуск кампании{{ /adv/v0/start }}

Описание метода

Метод запускает кампании в статусах 4 — готово к запуску — или 11 — пауза. Чтобы запустить кампанию, проверьте ее бюджет. Если бюджета недостаточно, пополните его.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 сек 5 запросов 200 мс 5 запросов
Сервисный 1 сек 5 запросов 200 мс 5 запросов
Базовый с секретом 1 сек 5 запросов 200 мс 5 запросов
Базовый 1 ч 5 запросов 12 мин 1 запрос
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234

ID кампании

Responses

Response samples

Content type
application/json
Example

Некорректный ID кампании

{
  • "error": "Invalid Advert: invalid advert"
}

Пауза кампании{{ /adv/v0/pause }}

Описание метода

Метод ставит кампании в статусе 9 — активна — на паузу.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 сек 5 запросов 200 мс 5 запросов
Сервисный 1 сек 5 запросов 200 мс 5 запросов
Базовый с секретом 1 сек 5 запросов 200 мс 5 запросов
Базовый 1 ч 5 запросов 12 мин 1 запрос
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234

ID кампании

Responses

Response samples

Content type
application/json
Example

Некорректный ID кампании

{
  • "error": "Invalid Advert: invalid advert"
}

Завершение кампании{{ /adv/v0/stop }}

Описание метода

Метод завершает кампании в статусах:

  • 9 — активна
  • 11 — пауза
Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 сек 5 запросов 200 мс 5 запросов
Сервисный 1 сек 5 запросов 200 мс 5 запросов
Базовый с секретом 1 сек 5 запросов 200 мс 5 запросов
Базовый 1 ч 5 запросов 12 мин 1 запрос
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234

ID кампании

Responses

Response samples

Content type
application/json
Example

Некорректный ID кампании

{
  • "error": "Invalid Advert: invalid advert"
}

Изменение мест размещения в кампаниях с ручной ставкой{{ /adv/v0/auction/placements }}

Описание метода

Метод меняет места размещения в кампаниях с ручной ставкой и моделью оплаты за показы — cpm.

Для кампаний в статусах 4, 9 и 11.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 сек 1 запрос 1 сек 1 запрос
Сервисный 1 сек 1 запрос 1 сек 1 запрос
Базовый с секретом 1 сек 1 запрос 1 сек 1 запрос
Базовый 1 ч 2 запроса 30 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects <= 50 items

Места размещения в кампаниях

Responses

Request samples

Content type
application/json
{
  • "placements": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "detail": "can not deserialize response body",
  • "origin": "camp-api-public-cache",
  • "request_id": "9a929a81ea9dc1601fcc4be81f32c1cb",
  • "status": 400,
  • "title": "invalid payload"
}

Изменение ставок в кампаниях{{ /api/advert/v1/bids }}

Описание метода

Метод меняет ставки карточек товаров по артикулам WB в кампаниях:

  • с единой ставкой
  • с ручной ставкой
  • с моделью оплаты cpc — за клики

Для кампаний в статусах 4, 9 и 11.

В запросе укажите место размещения в параметре placement:

  • combined — в поиске и рекомендациях для кампаний с единой ставкой
  • search или recommendations — в поиске или рекомендациях для кампаний с ручной ставкой
Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 сек 5 запросов 200 мс 5 запросов
Сервисный 1 сек 5 запросов 200 мс 5 запросов
Базовый с секретом 1 сек 5 запросов 200 мс 5 запросов
Базовый 1 ч 2 запроса 30 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects <= 50 items

Ставки в кампаниях

Responses

Request samples

Content type
application/json
{
  • "bids": [
    ]
}

Response samples

Content type
application/json
{
  • "bids": [
    ],
  • "currency": "RUB"
}

Изменение списка карточек товаров в кампаниях{{ /adv/v0/auction/nms }}

Описание метода

Метод добавляет и удаляет карточки товаров в кампаниях.

Для кампаний в статусах 4, 9 и 11.

Для добавляемых товаров устанавливается текущая минимальная ставка.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 сек 1 запрос 1 сек 1 запрос
Сервисный 1 сек 1 запрос 1 сек 1 запрос
Базовый с секретом 1 сек 1 запрос 1 сек 1 запрос
Базовый 1 ч 2 запроса 30 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects <= 20 items

Карточки товаров в кампаниях

Responses

Request samples

Content type
application/json
{
  • "nms": [
    ]
}

Response samples

Content type
application/json
{
  • "nms": [
    ]
}

Рекомендуемые ставки для карточек товаров и поисковых кластеров{{ /api/advert/v0/bids/recommendations }}

Описание метода

Метод возвращает рекомендуемые ставки для карточек товаров и поисковых кластеров кампании. Можно использовать для кампаний с типами оплаты cpm — за показы и cpc — за клики.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 5 запросов 12 сек 5 запросов
Сервисный 1 мин 5 запросов 12 сек 5 запросов
Базовый с секретом 1 мин 5 запросов 12 сек 5 запросов
Базовый 1 ч 20 запросов 3 мин 1 запрос
Authorizations:
HeaderApiKey
query Parameters
nmId
required
integer <int64>
Example: nmId=123456789

Артикул WB

advertId
required
integer <int64>
Example: advertId=987654321

ID кампании

Responses

Response samples

Content type
application/json
Example
{
  • "advertId": 987654321,
  • "base": {
    },
  • "nmId": 123456789,
  • "normQueries": [
    ],
  • "paymentType": "cpm"
}

Конфигурационные значения продвижения{{ /api/advert/v1/config }}

Описание метода

Метод возвращает валюту, код валюты профиля продавца и допустимые шаги ставок для метода POST /api/advert/v1/normquery/bids

Метод доступен по Персональному токену, Сервисному токену
Лимит запросов на один профиль продавца:
Период Лимит Интервал Всплеск
1 мин 1 запрос 1 мин 10 запросов
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "cpcStep": 500,
  • "cpmStep": 100000,
  • "currency": "UZS",
  • "currencyCode": 860,
  • "minDailyLimit": 100000,
  • "minTopUp": 10000
}

Получить настройки дневных лимитов кампаний{{ /api/advert/v0/daily-limits }}

Описание метода
Метод доступен по Персональному токену, Сервисному токену

Метод возвращает текущие настройки дневных лимитов кампаний CPC — максимальных сумм, которые кампании могут потратить на продвижение в течение суток.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 5 запросов 12 сек 5 запросов
Сервисный 1 мин 5 запросов 12 сек 5 запросов
Authorizations:
HeaderApiKey
query Parameters
advertIds
required
string
Example: advertIds=12346567,987654321

ID кампаний, максимум 100. Укажите значения через запятую

Responses

Response samples

Content type
application/json
{
  • "adverts": [
    ]
}

Настройка дневных лимитов кампаний{{ /api/advert/v0/daily-limits }}

Описание метода
Метод доступен по Персональному токену, Сервисному токену

Метод включает, выключает и обновляет дневной лимит кампаний.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 5 запросов 12 сек 5 запросов
Сервисный 1 мин 5 запросов 12 сек 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
advertIds
required
Array of integers <int64> [ 1 .. 100 ] items [ items <int64 > >= 1 ]

ID кампаний

enabled
required
boolean

Включить лимит:

  • true — да
  • false — нет
dailyLimit
integer <int64> >= 1000

Сумма дневного лимита. Параметр обязателен при "enabled": true. Минимально допустимая сумма указана в поле minDailyLimit метода GET /api/advert/v1/config

carryOverEnabled
boolean

Переносить неиспользованный остаток лимита на следующий день:

  • true — да
  • false — нет

Параметр обязателен при "enabled": true

Responses

Request samples

Content type
application/json
{
  • "advertIds": [
    ],
  • "enabled": true,
  • "dailyLimit": 1000,
  • "carryOverEnabled": true
}

Response samples

Content type
application/json
{
  • "adverts": [
    ]
}

Поисковые кластеры

Для доступа к методам используйте токен для категории Продвижение

Поисковые кластеры

Кластер запросов — это сгруппированный список запросов, по которым покупатели ищут товары на WB. В кластер входят:

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

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

Чтобы получить кластеры, по которым уже были показы, используйте метод статистики поисковых запросов.

Для кампаний с ручной ставкой можно установить или удалить ставки в валюте профиля продавца. Валюту профиля продавца и шаги ставок можно уточнить в ответе метода GET /api/advert/v1/config. Ставки индивидуальны для каждого поискового кластера.

Исключения

Установите минус-фразы, чтобы исключить кластеры запросов из кампаний. Товар не будет продвигаться по минус-фразам.

Список ставок поисковых кластеров{{ /adv/v0/normquery/get-bids }}

Описание метода

Метод возвращает список поисковых кластеров со ставками по:

  • ID кампаний
  • артикулам WB
Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 сек 5 запросов 200 мс 10 запросов
Сервисный 1 сек 5 запросов 200 мс 10 запросов
Базовый с секретом 1 сек 5 запросов 200 мс 10 запросов
Базовый 1 ч 5 запросов 12 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects <= 100 items

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "bids": [
    ]
}

Установить ставки для поисковых кластеров в валюте профиля продавца{{ /api/advert/v1/normquery/bids }}

Описание метода
Метод доступен по Персональному токену, Сервисному токену

Метод устанавливает ставки на поисковые кластеры в валюте профиля продавца. Можно использовать только для кампаний c ручной ставкой и моделью оплаты cpm — за показы.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 сек 2 запроса 500 мс 4 запроса
Сервисный 1 сек 2 запроса 500 мс 4 запроса
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects <= 100 items

Responses

Request samples

Content type
application/json
{
  • "bids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": [
    ],
  • "failed": [
    ]
}

Установить ставки для поисковых кластеров{{ /adv/v0/normquery/bids }}

Описание метода

Метод устанавливает ставки в рублях на поисковые кластеры.
Можно использовать только для кампаний с:

  • ручной ставкой
  • моделью оплаты cpm — за показы
Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 сек 2 запроса 500 мс 4 запроса
Сервисный 1 сек 2 запроса 500 мс 4 запроса
Базовый с секретом 1 сек 2 запроса 500 мс 4 запроса
Базовый 1 ч 5 запросов 12 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects <= 100 items

Responses

Request samples

Content type
application/json
{
  • "bids": [
    ]
}

Response samples

Content type
application/json
{
  • "detail": "invalid payment_type value",
  • "origin": "camp-api-public-cache",
  • "request_id": "7e5cb1f106cc6e85b5b29eb2e8815da2",
  • "status": 400,
  • "title": "invalid payload"
}

Удалить ставки поисковых кластеров{{ /adv/v0/normquery/bids }}

Описание метода

Метод удаляет ставки с поисковых кластеров.
Можно использовать только для кампаний с:

  • ручной ставкой
  • моделью оплаты cpm — за показы
Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 сек 5 запросов 200 мс 10 запросов
Сервисный 1 сек 5 запросов 200 мс 10 запросов
Базовый с секретом 1 сек 5 запросов 200 мс 10 запросов
Базовый 1 ч 5 запросов 12 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects <= 100 items

Responses

Request samples

Content type
application/json
{
  • "bids": [
    ]
}

Response samples

Content type
application/json
{
  • "detail": "invalid payment_type value",
  • "origin": "camp-api-public-cache",
  • "request_id": "7e5cb1f106cc6e85b5b29eb2e8815da2",
  • "status": 400,
  • "title": "invalid payload"
}

Список минус-фраз кампаний{{ /adv/v0/normquery/get-minus }}

Описание метода

Метод возвращает список минус-фраз по:

  • ID кампаний
  • артикулам WB
Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 сек 5 запросов 200 мс 10 запросов
Сервисный 1 сек 5 запросов 200 мс 10 запросов
Базовый с секретом 1 сек 5 запросов 200 мс 10 запросов
Базовый 1 ч 5 запросов 12 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects <= 100 items

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Установка и удаление минус-фраз{{ /adv/v0/normquery/set-minus }}

Описание метода

Метод устанавливает и удаляет минус-фразы в кампаниях c единой и ручной ставкой.

Отправка пустого массива удаляет все минус-фразы
Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 сек 5 запросов 200 мс 10 запросов
Сервисный 1 сек 5 запросов 200 мс 10 запросов
Базовый с секретом 1 сек 5 запросов 200 мс 10 запросов
Базовый 1 ч 5 запросов 12 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
advert_id
required
integer

ID кампании

nm_id
required
integer

Артикул WB

norm_queries
required
Array of strings <= 1000 items

Responses

Request samples

Content type
application/json
{
  • "advert_id": 1825035,
  • "nm_id": 983512347,
  • "norm_queries": [
    ]
}

Response samples

Content type
application/json
{
  • "detail": "invalid payment_type value",
  • "origin": "camp-api-public-cache",
  • "request_id": "7e5cb1f106cc6e85b5b29eb2e8815da2",
  • "status": 400,
  • "title": "invalid payload"
}

Списки активных и неактивных поисковых кластеров{{ /adv/v0/normquery/list }}

Описание метода

Метод возвращает списки активных и неактивных поисковых кластеров, по которым было не меньше 100 показов.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 сек 5 запросов 200 мс 10 запросов
Сервисный 1 сек 5 запросов 200 мс 10 запросов
Базовый с секретом 1 сек 5 запросов 200 мс 10 запросов
Базовый 1 ч 5 запросов 12 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects <= 100 items

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Финансы

Для доступа к методам используйте токен для категории Продвижение

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

Баланс{{ /adv/v1/balance }}

Описание метода

Метод возвращает информацию о:

  • счёте кабинета Продвижения WB. Его пополняет продавец.
  • балансе — максимальной сумме для оплаты кампании по взаиморасчету: удержании средств из будущих продаж. Баланс пополнить нельзя, он рассчитывается автоматически на основе отчётов по продвижению.
  • бонусных начислениях WB.

Чтобы получить информацию о бюджетах кампаний, используйте метод Бюджеты кампаний.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 сек 1 запрос 1 сек 5 запросов
Сервисный 1 сек 1 запрос 1 сек 5 запросов
Базовый с секретом 1 сек 1 запрос 1 сек 5 запросов
Базовый 1 ч 2 запроса 30 мин 1 запрос
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "balance": 11083,
  • "net": 0,
  • "currency": "RUB",
  • "bonus": 15187,
  • "cashbacks": [
    ]
}

Остатки бюджетов кампаний{{ /api/advert/v2/budget }}

Описание метода

Метод возвращает информацию об остатках бюджетов кампаний. Для кампаний в статусах:

  • 4 — готова к запуску
  • 9 — активна
  • 11 — на паузе
Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 20 запросов 3 сек 4 запроса
Сервисный 1 мин 20 запросов 3 сек 4 запроса
Базовый с секретом 1 мин 20 запросов 3 сек 4 запроса
Базовый 1 ч 4 запроса 15 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
advertIds
required
Array of integers [ 1 .. 50 ] items

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

Responses

Request samples

Content type
application/json
{
  • "advertIds": [
    ]
}

Response samples

Content type
application/json
{
  • "adverts": [
    ]
}

Бюджет кампании{{ /adv/v1/budget }} Deprecated

Описание метода

Метод будет отключен 16 ноября.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 сек 4 запроса 250 мс 4 запроса
Сервисный 1 сек 4 запроса 250 мс 4 запроса
Базовый с секретом 1 сек 4 запроса 250 мс 4 запроса
Базовый 1 ч 4 запроса 15 мин 1 запрос
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1

ID кампании

Responses

Response samples

Content type
application/json
{
  • "cash": 0,
  • "netting": 0,
  • "total": 500,
  • "currency": "RUB"
}

Пополнение бюджета кампании{{ /adv/v1/budget/deposit }}

Описание метода

Метод пополняет бюджет кампании.
Чтобы запустить кампанию после пополнения бюджета, используйте метод Запуск кампании.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 сек 1 запрос 1 сек 5 запросов
Сервисный 1 сек 1 запрос 1 сек 5 запросов
Базовый с секретом 1 сек 1 запрос 1 сек 5 запросов
Базовый 1 ч 5 запросов 12 мин 1 запрос
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

ID кампании

Request Body schema: application/json
required
sum
integer

Общая сумма пополнения бюджета в базовых единицах валюты профиля продавца

cashback_sum
integer

Сумма пополнения бюджета промо-бонусами.
Пополнить можно только определённый процент от общей суммы, указанный в поле percent ответа метода получения баланса.
Оставшаяся часть общей суммы спишется с указанного источника пополнения. Пополнить можно только определённый процент от общей суммы, указанный в поле percent ответа метода получения баланса.
Оставшаяся часть общей суммы спишется с указанного источника пополнения.
Списать промо-бонусы можно только для источников пополнения:

  • 0 — счёт
  • 1 — баланс
cashback_percent
integer

Процент от суммы пополнения, который можно пополнить промо-бонусами. Нужно указать значение поля percent из ответа метода получения баланса
Если вы указали cashback_sum, параметр cashback_percent становится обязательным

type
integer

Тип источника пополнения:

  • 0 — Счёт
  • 1 — Баланс
  • 3 — Бонусы
return
boolean

Флаг возврата ответа (true — в ответе вернется обновлённый размер бюджета кампании, false или не указать параметр вообще — не вернётся.)

Responses

Request samples

Content type
application/json
{
  • "sum": 5000,
  • "cashback_sum": 1000,
  • "cashback_percent": 50,
  • "type": 1,
  • "return": true
}

Response samples

Content type
application/json

Ответ при "return": true

{
  • "total": 7289,
  • "currency": "RUB"
}

Получение истории затрат{{ /adv/v1/upd }}

Описание метода

Метод формирует список фактических затрат на рекламные кампании за заданный период.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 сек 1 запрос 1 сек 5 запросов
Сервисный 1 сек 1 запрос 1 сек 5 запросов
Базовый с секретом 1 сек 1 запрос 1 сек 5 запросов
Базовый 1 ч 1 запрос 1 ч 1 запрос
Authorizations:
HeaderApiKey
query Parameters
from
required
string <date>
Example: from=2023-07-31

Начало интервала

to
required
string <date>
Example: to=2023-08-02

Конец интервала.
(Минимальный интервал 1 день, максимальный 31)

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Получение истории пополнений счёта{{ /adv/v1/payments }}

Описание метода

Метод возвращает историю пополнений счёта WB Продвижение за заданный период.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 сек 1 запрос 1 сек 5 запросов
Сервисный 1 сек 1 запрос 1 сек 5 запросов
Базовый с секретом 1 сек 1 запрос 1 сек 5 запросов
Базовый 1 ч 1 запрос 1 ч 1 запрос
Authorizations:
HeaderApiKey
query Parameters
from
string <date>
Example: from=2023-07-31

Начало интервала

to
string <date>
Example: to=2023-08-02

Конец интервала.
(Минимальный интервал 1 день, максимальный 31)

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Статистика

Для доступа к методам используйте токен для категории Продвижение

Методы получения статистики, в частности:

  1. Поисковых кластеров

  2. Кампаний WB Продвижение

  3. Поисковых кластеров с детализацией по дням

Статистика поисковых кластеров{{ /adv/v0/normquery/stats }}

Описание метода

Метод формирует статистику по поисковым кластерам за указанный период.
Можно использовать для кампаний с моделями оплаты cpm — за показы и cpc — за клики.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 10 запросов 6 сек 20 запросов
Сервисный 1 мин 10 запросов 6 сек 20 запросов
Базовый с секретом 1 мин 10 запросов 6 сек 20 запросов
Базовый 1 ч 5 запросов 12 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
from
required
string <date>

Дата начала периода

to
required
string <date>

Дата окончания периода

required
Array of objects <= 100 items

Responses

Request samples

Content type
application/json
{
  • "from": "2025-10-07",
  • "to": "2025-10-08",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "stats": [
    ]
}

Статистика кампаний{{ /adv/v3/fullstats }}

Описание метода

Метод формирует статистику для кампаний независимо от типа.

Максимальный период в запросе — 31 день.

Для кампаний в статусах 7, 9 и 11.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 3 запроса 20 сек 1 запрос
Сервисный 1 мин 3 запроса 20 сек 1 запрос
Базовый с секретом 1 мин 3 запроса 20 сек 1 запрос
Базовый 1 ч 1 запрос 1 ч 1 запрос
Authorizations:
HeaderApiKey
query Parameters
ids
required
string
Example: ids=22161678,28449281,28155229

ID кампаний, максимум 50 значений

beginDate
required
string <date>
Example: beginDate=2025-09-07

Дата начала интервала

endDate
required
string <date>
Example: endDate=2025-09-08

Дата окончания интервала

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Статистика по поисковым кластерам с детализацией по дням{{ /adv/v1/normquery/stats }}

Описание метода

Метод формирует статистику по поисковым кластерам за указанный период с детализацией по дням. Можно использовать для кампаний с моделями оплаты cpm — за показы и cpc — за клики.

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 10 запросов 6 сек 20 запросов
Сервисный 1 мин 10 запросов 6 сек 20 запросов
Базовый с секретом 1 мин 10 запросов 6 сек 20 запросов
Базовый 1 ч 2 запроса 30 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
from
required
string <date>

Дата начала периода

to
required
string <date>

Дата окончания периода периода

required
Array of objects <= 100 items

Responses

Request samples

Content type
application/json
{
  • "from": "2026-01-01",
  • "to": "2026-01-30",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Календарь акций

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

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

  1. Список акций
  2. Детальную информацию об акциях
  3. Список товаров для участия в акциях

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

Список акций{{ /api/v1/calendar/promotions }}

Описание метода

Метод возвращает список акций в WB с датами и временем проведения.

Лимит запросов на один профиль продавца для всех методов категории Календарь акций:
Тип Период Лимит Интервал Всплеск
Персональный 6 сек 10 запросов 600 мс 5 запросов
Сервисный 6 сек 10 запросов 600 мс 5 запросов
Базовый с секретом 6 сек 10 запросов 600 мс 5 запросов
Базовый 1 ч 1 запрос 1 ч 1 запрос
Authorizations:
HeaderApiKey
query Parameters
startDateTime
required
string <date-time>
Example: startDateTime=2023-09-01T00:00:00Z

Начало периода, формат YYYY-MM-DDTHH:MM:SSZ

endDateTime
required
string <date-time>
Example: endDateTime=2024-08-01T23:59:59Z

Конец периода, формат YYYY-MM-DDTHH:MM:SSZ

allPromo
required
boolean
Default: false

Показать акции:

  • false — доступные для участия
  • true — все акции
limit
integer <uint> [ 1 .. 1000 ]
Example: limit=10

Количество запрашиваемых акций

offset
integer <uint> >= 0
Example: offset=0

После какого элемента выдавать данные

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Детальная информация об акциях{{ /api/v1/calendar/promotions/details }}

Описание метода

Метод возвращает подробную информацию об акции по ID.

Лимит запросов на один профиль продавца для всех методов категории Календарь акций:
Тип Период Лимит Интервал Всплеск
Персональный 6 сек 10 запросов 600 мс 5 запросов
Сервисный 6 сек 10 запросов 600 мс 5 запросов
Базовый с секретом 6 сек 10 запросов 600 мс 5 запросов
Базовый 1 ч 1 запрос 1 ч 1 запрос
Authorizations:
HeaderApiKey
query Parameters
promotionIDs
required
Array of integers [ 1 .. 100 ] items unique
Example: promotionIDs=1&promotionIDs=3&promotionIDs=64

ID акций, по которым нужно вернуть информацию

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Список товаров для участия в акции{{ /api/v1/calendar/promotions/nomenclatures }}

Описание метода

Метод формирует список товаров, подходящих для участия в акции. Эти товары можно добавить в акцию с помощью отдельного метода.

Данный метод неприменим для автоакций.
Лимит запросов на один профиль продавца для всех методов категории Календарь акций:
Период Лимит Интервал Всплеск
6 сек 10 запросов 600 мс 5 запросов
Authorizations:
HeaderApiKey
query Parameters
promotionID
required
integer
Example: promotionID=1

ID акции

inAction
required
boolean
Default: false
Example: inAction=true

Участвует в акции:

  • true — да
  • false — нет
limit
integer <uint> [ 1 .. 1000 ]
Example: limit=10

Количество запрашиваемых товаров

offset
integer <uint> >= 0
Example: offset=0

После какого элемента выдавать данные

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Добавить товар в акцию{{ /api/v1/calendar/promotions/upload }}

Описание метода

Метод создаёт задание на загрузку товара в акцию.
Состояние загрузки можно проверить с помощью отдельных методов.

Данный метод неприменим для автоакций.
Лимит запросов на один профиль продавца для всех методов категории Календарь акций:
Тип Период Лимит Интервал Всплеск
Персональный 6 сек 10 запросов 600 мс 5 запросов
Сервисный 6 сек 10 запросов 600 мс 5 запросов
Базовый с секретом 6 сек 10 запросов 600 мс 5 запросов
Базовый 1 ч 1 запрос 1 ч 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
object

Данные запроса

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}