Поиск
API docs by Redocly

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

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

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

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

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

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

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

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

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

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

Кампании

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

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

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

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

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

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 5 запросов 200 миллисекунд 5 запросов
Authorizations:
HeaderApiKey

Responses

Response samples

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

Информация о кампаниях{{ /adv/v1/promotion/adverts }}

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

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

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

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 5 запросов 200 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
status
integer
Enum: -1 4 7 8 9 11
Статус кампании:
-1 — кампания удалена, процесс удаления будет завершен в течение 10 минут
4 — готова к запуску
7 — завершена
8 — отказался
9 — активна
11 — на паузе
type
integer
Enum: 4 5 6 7 8
Тип кампании:
4 — в каталоге (устаревший тип)
5 — в карточке товара (устаревший тип)
6 — в поиске (устаревший тип)
7 — в рекомендациях на главной странице (устаревший тип)
8 — единая ставка
order
required
string
Enum: "create" "change" "id"
Порядок:
create — по времени создания кампании
change — по времени последнего изменения кампании
id — по ID кампании
direction
string
Enum: "desc" "asc"
Направление:
desc — от большего к меньшему
asc — от меньшего к большему
Request Body schema: application/json
required
Array
integer

Список ID кампаний. Максимум 50.

Получить ID кампаний можно методом Списки кампаний

Responses

Request samples

Content type
application/json
[
  • 1234567,
  • 63453471
]

Response samples

Content type
application/json
Example
[
  • {
    }
]

Информация о кампаниях с ручной ставкой{{ /adv/v0/auction/adverts }}

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

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

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 5 запросов 200 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
ids
Array of strings [ 1 .. 50 ] items
Example: ids=12345,23456,34567,45678,56789

ID кампаний

statuses
Array of strings
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
[
  • {
    }
]

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

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

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

  1. Конфигурационных значений Продвижения
  2. Предметов для кампаний
  3. Карточек товаров для кампаний

Конфигурационные значения Продвижения{{ /adv/v0/config }}

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

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

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

Responses

Response samples

Content type
application/json
{
  • "categories": [
    ],
  • "config": [
    ]
}

Создать кампанию с единой ставкой{{ /adv/v1/save-ad }}

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

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

  • каталоге
  • поиске
  • карточках товаров
  • рекомендациях на главной странице WB
Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
20 секунд 1 запрос 20 секунд 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
type
integer
Тип кампании с единой ставкой:
8
name
string

Название кампании (max. 128 символов)

subjectId
integer

ID предмета, для которого создается кампания.
Существующие у продавца ID можно получить методом из раздела "Контент / Просмотр" - "Список НМ", поле ответа - subjectID.

sum
integer

Сумма пополнения

btype
integer
Tип списания.
0 - Счёт
1 - Баланс
3 - Бонусы
on_pause
boolean
После создания кампания:
true - будет на паузе.
Запуск кампании будет доступен через 3 минуты после создания кампании.
false - будет сразу запущена
nms
Array of integers

Массив артикулов WB.
Максимум 100 артикулов.

cpm
integer

Ставка.
Если будет указана ставка меньше допустимого размера, то автоматически установится ставка минимально допустимого размера.

Responses

Request samples

Content type
application/json
{
  • "type": 8,
  • "name": "Парашюты",
  • "subjectId": 270,
  • "sum": 500,
  • "btype": 1,
  • "on_pause": true,
  • "nms": [
    ],
  • "cpm": 10
}

Response samples

Content type
application/json
"9008917"

Создать кампанию с ручной ставкой{{ /adv/v2/seacat/save-ad }}

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

Метод создаёт кампанию с ручной ставкой для продвижения товаров в результатах поиска WB.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 5 запросов 12 секунд 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
campaignName
string

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

nms
Array of integers

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

Responses

Request samples

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

Response samples

Content type
text/plain
Нет доступных категорий для рк. Создайте новую кампанию для попадания в текущие категории

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

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

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

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
12 секунд 1 запрос 12 секунд 5 запросов
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
Example
[
  • {
    }
]

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

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

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

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 5 запросов 12 секунд 5 запросов
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. Изменить ставки в кампаниях с ручной ставкой

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

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

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

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

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 5 запросов 200 миллисекунд 5 запросов
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 запросов
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": "newnmame"
}

Response samples

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

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

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

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

Чтобы запустить кампанию со статусом 4, необходимо выполнить два условия:

  1. После создания кампании в кабинете WB. Продвижение нажать кнопку Применить изменения.
  2. Установить бюджет — максимальную сумму затрат на кампанию.

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

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 5 запросов 200 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234

ID кампании

Responses

Response samples

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

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

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

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

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 5 запросов 200 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234

ID кампании

Responses

Response samples

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

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

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

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

  • 4 — готово к запуску
  • 9 — приостановлена продавцом
  • 11 — пауза
Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 5 запросов 200 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234

ID кампании

Responses

Response samples

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

Изменение ставки{{ /adv/v0/cpm }} Deprecated

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

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
advertId
required
integer

ID кампании, где меняется ставка

type
required
integer
Enum: 5 6 7 8 9
кампании, где меняется ставка:
4 - кампания в каталоге (устаревший тип)
5 - кампания в карточке товара (устаревший тип)
6 - кампания в поиске (устаревший тип)
7 - кампания в рекомендациях на главной странице (устаревший тип)
8 - единая ставка
9 - ручная ставка
cpm
required
integer

Новое значение ставки

param
required
integer

Параметр, для которого будет внесено изменение. Является значением subjectId (для кампании в поиске и рекомендациях (устаревшие типы кампаний)), setId (для кампании в карточке товара (устаревший тип кампании)) или menuId (для кампании в каталоге (устаревший тип кампании)).
Для кампании с единой ставкой указывать этот параметр не требуется.

instrument
integer

тип кампании для изменения ставки в 4 - каталог (устаревший тип), 6 - поиск (устаревший тип)

Responses

Request samples

Content type
application/json
{
  • "advertId": 789,
  • "type": 5,
  • "cpm": 456,
  • "param": 23,
  • "instrument": 4
}

Response samples

Content type
text/plain
Example
Некорректное значение параметра param

Изменение ставок{{ /adv/v0/bids }}

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

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

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

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

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

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 5 запросов 200 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects (V0AdvertMultibid) <= 20 items

Responses

Request samples

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

Response samples

Content type
application/json
Example

Повторяется ID кампании.
В .bids[n] указана позиция кампании в массиве запроса bids

{
  • "errors": [
    ],
  • "request_id": "2c991dcab0fe971e8c0321c340a8c7fd",
  • "status": 400,
  • "title": "invalid payload",
  • "type": "Bad Request"
}

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

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

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

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

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 1 запрос 1 секунда 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
{
  • "detail": "can not deserialize response body",
  • "origin": "camp-api-public-cache",
  • "request_id": "9a929a81ea9dc1601fcc4be81f32c1cb",
  • "status": 400,
  • "title": "invalid payload"
}

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

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

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

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

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 5 запросов 200 миллисекунд 5 запросов
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": [
    ]
}

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

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

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

  1. Управление активностью и установка/удаление фиксированных фраз.
  2. Установка/удаление минус-фраз:
    1. Фразового соответствия
    2. Точного соответствия
    3. Из поиска
    4. Для кампании с единой ставкой
  3. Получение и изменение списка карточек товаров в кампаниях с единой ставкой.
  4. Изменение списка карточек товаров в кампаниях с ручной ставкой.

Управление активностью фиксированных фраз{{ /adv/v1/search/set-plus }}

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

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

Установить или удалить фиксированные фразы можно через отдельный метод.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
500 миллисекунд 1 запрос 500 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

ID кампании

fixed
boolean

Новое состояние (false - сделать неактивными, true - сделать активными)

Responses

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

Установка/удаление фиксированных фраз{{ /adv/v1/search/set-plus }}

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

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

Отправка пустого массива в методе удаляет все фиксированные фразы и отключает активность всех фиксированных фраз кампании.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
500 миллисекунд 1 запрос 500 миллисекунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

ID кампании

Request Body schema: application/json
required
pluse
Array of strings

Список фиксированных фраз (max. 100)

Responses

Request samples

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

Response samples

Content type
application/json
[
  • "Фраза 1",
  • "Фраза 2"
]

Установка/удаление минус-фраз фразового соответствия{{ /adv/v1/search/set-phrase }}

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

Метод устанавливает и удаляет минус-фразы фразового соответствия в кампаниях с ручной ставкой. Фразовое соответствие — это когда поисковый запрос содержит в себе минус-фразу.

Данные минус-фразы нужно ввести вручную. Максимально допустимое количество минус-фраз в кампании — 1000.

Отправка пустого массива удаляет все минус-фразы фразового соответствия из кампании.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 2 запроса 500 миллисекунд 2 запроса
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

ID кампании

Request Body schema: application/json
required
phrase
Array of strings

Минус-фразы (макс. 1000 шт.)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

Установка/удаление минус-фраз точного соответствия{{ /adv/v1/search/set-strong }}

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

Метод устанавливает и удаляет минус-фразы точного соответствия в кампаниях с ручной ставкой. Точное соответствие — это когда поисковый запрос полностью соответствует минус-фразе.

Данные минус-фразы нужно ввести вручную. Максимально допустимое количество минус-фраз в кампании — 1000.

Отправка пустого массива удаляет все минус-фразы точного соответствия из кампании.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 2 запроса 500 миллисекунд 2 запроса
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

ID кампании

Request Body schema: application/json
required
strong
Array of strings

Минус-фразы (макс. 1000 шт.)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

Установка/удаление минус-фраз в поиске{{ /adv/v1/search/set-excluded }}

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

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

Данные фразы можно выбрать из списка запросов, по которым покупатели находили ваш товар. Список запросов можно получить в статистике ключевых фраз.
Максимально допустимое количество минус-фраз в кампании — 1000.

Отправка пустого массива удаляет все минус-фразы из поиска из кампании.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 2 запроса 500 миллисекунд 2 запроса
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

ID кампании

Request Body schema: application/json
required
excluded
Array of strings

Минус-фразы (макс. 1000 шт.)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

Установка/удаление минус-фраз для кампании с единой ставкой{{ /adv/v1/auto/set-excluded }}

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

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

Данные фразы можно выбрать из списка запросов, по которым покупатели находили ваш товар. Список запросов можно получить в статистике ключевых фраз.

Отправка пустого массива удаляет все минус-фразы из кампании.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
6 секунд 1 запрос 6 секунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

ID кампании

Request Body schema: application/json
required
excluded
Array of strings

Список фраз (макс. 1000 шт.)

Responses

Request samples

Content type
application/json
Example

Установка минус-фраз

{
  • "excluded": [
    ]
}

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

Список карточек товаров для кампании с единой ставкой{{ /adv/v1/auto/getnmtoadd }}

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

Метод формирует список карточек товаров, которые можно добавить в кампанию с единой ставкой.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 1 запрос 1 секунда 5 запросов
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1

ID кампании

Responses

Response samples

Content type
application/json
[
  • 1111111111,
  • 2222222222,
  • 3333333333,
  • 4444444444
]

Изменение списка карточек товаров в кампании с единой ставкой{{ /adv/v1/auto/updatenm }}

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

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

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

Проверки по параметру delete не предусмотрено.

Если пришел ответ со статус-кодом 200, а изменений не произошло, проверьте, чтобы запрос соответствовал документации.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 60 запросов 1 секунда 5 запросов
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1

ID кампании

Request Body schema: application/json
required
add
Array of integers

Карточки товаров, которые необходимо добавить

delete
Array of integers

Карточки товаров, которые необходимо удалить

Responses

Request samples

Content type
application/json
{
  • "add": [
    ],
  • "delete": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "Не найдено"
}

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

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

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

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

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

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 1 запрос 1 секунда 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": [
    ]
}

Финансы

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

Вы можете посмотреть ваш баланс и бюджет ваших рекламных кампаний. Бюджет рекламных кампаний можно пополнить.

Также вы можете узнать историю ваших затрат и пополнений счёта.

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

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

Метод предоставляет информацию о:

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

Информацию о бюджете кампаний можно получить в отдельном методе.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 1 запрос 1 секунда 5 запросов
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "balance": 11083,
  • "net": 0,
  • "bonus": 15187
}

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

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

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

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 4 запроса 250 миллисекунд 4 запроса
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1

ID кампании

Responses

Response samples

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

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

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

Метод пополняет бюджет кампании. Можно использовать, чтобы запустить кампанию в статусе 11 — пауза.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 1 запрос 1 секунда 5 запросов
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

ID кампании

Request Body schema: application/json
required
sum
integer

Сумма пополнения

type
integer
Тип источника пополнения:
0 - Счёт
1 - Баланс
3 - Бонусы
return
boolean

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

Responses

Request samples

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

Response samples

Content type
application/json

Ответ при return=true

{
  • "total": 500
}

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

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

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

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 1 запрос 1 секунда 5 запросов
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 }}

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

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

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 1 запрос 1 секунда 5 запросов
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. Список медиакампаний
  3. Информация о медиакампании

Количество медиакампаний{{ /adv/v1/count }}

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

Метод предоставляет количество медиакампаний продавца с группировкой по статусам.

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

Responses

Response samples

Content type
application/json
{
  • "all": 6,
  • "adverts": {
    }
}

Список медиакампаний{{ /adv/v1/adverts }}

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

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

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 10 запросов 100 миллисекунд 10 запросов
Authorizations:
HeaderApiKey
query Parameters
status
integer
Example: status=1
Статус медиакампании:
1 - черновик
2 - модерация
3 - отклонено (с возможностью вернуть на модерацию)
4 - готово к запуску
5 - запланировано
6 - на показах
7 - завершено
8 - отказался
9 - приостановлена продавцом
10 - пауза по дневному лимиту
11 - пауза
type
integer
Example: type=1
Тип медиакампании:
1 - размещение по дням
2 - размещение по просмотрам
limit
integer
Example: limit=1

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

offset
integer
Example: offset=1

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

order
string
Example: order=id
Порядок вывода ответа:
create - по времени создания медиакампании
id - по ID медиакампании
direction
string
Example: direction=desc
Порядок сортировки:
desc - от большего к меньшему
asc - от меньшего к большему

Responses

Response samples

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

Информация о медиакампании{{ /adv/v1/advert }}

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

Метод предоставляет информацию об одной кампании ВБ.Медиа. Вместо карточек товаров в медиакампаниях продвигаются рекламные баннеры продавца на сайте и в приложении WB.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 секунда 10 запросов 100 миллисекунд 10 запросов
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=23569

ID медиакампании

Responses

Response samples

Content type
application/json
{
  • "advertId": 23569,
  • "name": "Реклама денег принеси",
  • "brand": "Plank",
  • "type": 2,
  • "status": 11,
  • "createTime": "2023-07-19T11:13:41.195138+03:00",
  • "extended": {
    },
  • "items": [
    ]
}

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

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

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

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

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

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

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

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

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

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

endDateTime
required
string <RFC3339>
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 запросов
Authorizations:
HeaderApiKey
query Parameters
promotionIDs
required
string [ 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 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
object

Responses

Request samples

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

Response samples

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