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

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

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

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

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

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

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

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

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

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

Кампании

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

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

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

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

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

Максимум 5 запросов в секунду на один аккаунт продавца

Authorizations:

HeaderApiKey

Responses

Response samples

200
401
429

Content type

application/json

{"adverts": [{"type": 4,
"status": 8,
"count": 3,
"advert_list": [{"advertId": 6485174,
"changeTime": "2023-05-10T12:12:52.676254+03:00"
},
{"advertId": 6500443,
"changeTime": "2023-05-10T17:08:46.370656+03:00"
},
{"advertId": 7936341,
"changeTime": "2023-07-12T15:51:08.367478+03:00"
}
]
}
],
"all": 3
}

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

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

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

Максимум 5 запросов в секунду на один аккаунт продавца

Authorizations:

HeaderApiKey

query Parameters

status	integer Enum: -1 4 7 8 9 11 Статус кампании: `-1` - кампания в процессе удаления `4` - готова к запуску `7` - кампания завершена `8` - отказался `9` - идут показы `11` - кампания на паузе Кампания в процессе удаления. Статус означает, что кампания была удалена, и через 3-10 минут она исчезнет из ответа метода.
type	integer Enum: 4 5 6 7 8 9 Тип кампании: `4` - кампания в каталоге (устаревший тип) `5` - кампания в карточке товара (устаревший тип) `6` - кампания в поиске (устаревший тип) `7` - кампания в рекомендациях на главной странице (устаревший тип) `8` - автоматическая кампания `9` - Аукцион
order	string Enum: "create" "change" "id" Порядок: `create` (по времени создания кампании) `change` (по времени последнего изменения кампании) `id` (по ID кампании)
direction	string Enum: "desc" "asc" Направление: `desc` (от большего к меньшему) `asc` (от меньшего к большему) Например: `/adv/v1/promotion/adverts?type=6&order=change&direction=asc`

Request Body schema: application/json
required

Array

integer

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

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

Responses

Request samples

Payload

Content type

application/json

[1234567,
63453471
]

Response samples

200
400
401
422
429

Content type

application/json

Example

ResponseInfoAdvert

[{"endTime": "2100-01-01 00:00:00+03:00",
"createTime": "2023-05-31 16:57:42.654141+03:00",
"changeTime": "2023-06-21 22:10:43.074183+03:00",
"startTime": "2023-07-21 21:17:42.872376+03:00",
"name": "Носки_Шерстяные",
"params": [{"intervals": [{"begin": 3,
"end": 5
}
],
"price": 400,
"subjectId": 201,
"subjectName": "Носки",
"nms": [{"nm": 11111111,
"active": true
}
],
"active": false
}
],
"dailyBudget": 0,
"advertId": 12345,
"status": 9,
"type": 6,
"paymentType": "cpm",
"searchPluseState": false
}
]

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

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

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

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

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

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

Максимум 1 запрос в минуту на один аккаунт продавца

Authorizations:

HeaderApiKey

Responses

Response samples

200
401
429

Content type

application/json

{"categories": [{"id": 760,
"name": "Автомобильные товары",
"cpm_min": 112
}
],
"config": [{"description": "Минимальный бюджет кампании",
"name": "budget_min",
"value": "1000"
},
{"description": "Максимальный период в днях, за который можно получить статистику",
"name": "api_fullstat_day_depth",
"value": "31"
},
{"description": "Минимальная ставка CPM для автоматической кампании",
"name": "cpm_min_booster",
"value": "100"
},
{"description": "Минимальная ставка CPM для аукциона",
"name": "cpm_min_search_catalog",
"value": "150"
},
{"description": "Максимальное количество товаров для аукциона",
"name": "max_nm_count",
"value": "50"
},
{"description": "Максимальное количество товаров для автоматической кампании",
"name": "max_auto_nms",
"value": "100"
}
]
}

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

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

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

каталоге
поиске
карточках товаров
рекомендациях на главной странице WB

Максимум 1 запрос в 20 секунд на один аккаунт продавца

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

Payload

Content type

application/json

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

Response samples

200
400
401
422
429

Content type

text/plain

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

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

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

Максимум 5 запросов в минуту на один аккаунт продавца

Authorizations:

HeaderApiKey

Request Body schema: application/json

campaignName	string Название кампании
nms	Array of integers Карточки товаров для кампании. Доступные карточки товаров можно получить с помощью метода Карточки товаров для кампаний. Максимум 50 товаров (`nm`)

Responses

Request samples

Payload

Content type

application/json

{"name": "Телефоны",
"nms": [146168367,
200425104
]
}

Response samples

400
401
429

Content type

text/plain

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

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

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

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

Максимум 1 запрос в 12 секунд на один аккаунт продавца

Authorizations:

HeaderApiKey

Responses

Response samples

200
401
429

Content type

application/json

Example

Array

[{"name": "3D очки",
"id": 2560,
"count": 1899
}
]

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

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

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

Максимум 5 запросов в минуту на один аккаунт продавца

Authorizations:

HeaderApiKey

Request Body schema: application/json

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

Array

integer

Responses

Request samples

Payload

Content type

application/json

[123,
456,
765,
321
]

Response samples

200
400
401
429

Content type

application/json

[{"title": "Плед",
"nm": 146168367,
"subjectId": 765
}
]

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

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

Прежде чем запустить рекламную кампанию, вы можете изменить её ставку. Затем рекламные кампании можно:

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

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

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

Если размер ставки будет меньше допустимого, в ответе вы получите статус-код 422 — размер ставки не изменён.

При изменении ставки для кампании с типом `9` — Аукцион: 1. Значение `type` всегда будет `9` 1. Значение `instrument` всегда будет `6` (устаревший тип кампании). 1. Значение `param` всегда берётся из поля `id` структуры `subject` в [информации о кампании](./promotion#tag/Kampanii/paths/~1adv~1v1~1promotion~1adverts/post).

Максимум 5 запросов в секунду на один аккаунт продавца

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

Payload

Content type

application/json

{"advertId": 789,
"type": 5,
"cpm": 456,
"param": 23,
"instrument": 4
}

Response samples

400
401
422
429

Content type

text/plain

Example

IncorrectParamAdv

Некорректное значение параметра param

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

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

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

Для кампаний в любом статусе кроме -1, 7 и 8

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

Максимум 5 запросов в секунду на один аккаунт продавца

Authorizations:

HeaderApiKey

Request Body schema: application/json
required

required

Array of objects (V0AdvertMultibid) <= 20 items

Responses

Request samples

Payload

Content type

application/json

{"bids": [{"advert_id": 6348555,
"nm_bids": [{"nm": 3462354,
"bid": 500
}
]
}
]
}

Response samples

400
401
429

Content type

application/json

Example

CampaignIsNotUnique

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

{"errors": [{"detail": "advert 1234567 is not unique",
"field": ".bids[2]"
}
],
"request_id": "2c991dcab0fe971e8c0321c340a8c7fd",
"status": 400,
"title": "invalid payload",
"type": "Bad Request"
}

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

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

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

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

Максимум 5 запросов в секунду на один аккаунт продавца

Authorizations:

HeaderApiKey

query Parameters

id

required

integer

ID кампании

Responses

Response samples

400
401
429

Content type

application/json

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

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

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

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

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

Максимум 5 запросов в секунду на один аккаунт продавца

Authorizations:

HeaderApiKey

Request Body schema: application/json

advertId required	integer ID кампании, у которой меняется название
name required	string Новое название (максимум 100 символов)

Responses

Request samples

Payload

Content type

application/json

{"advertId": 2233344,
"name": "newnmame"
}

Response samples

400
401
422
429

Content type

text/plain

Example

InvalidRcIdAdv

Некорректный ID РК

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

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

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

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

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

Чтобы запустить кампанию со статусом 11, пополните её бюджет.

Максимум 5 запросов в секунду на один аккаунт продавца

Authorizations:

HeaderApiKey

query Parameters

id

required

integer

Example: id=1234

ID кампании

Responses

Response samples

400
401
422
429

Content type

text/plain

Example

InvalidRcIdAdv

Некорректный ID РК

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

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

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

Максимум 5 запросов в секунду на один аккаунт продавца

Authorizations:

HeaderApiKey

query Parameters

id

required

integer

Example: id=1234

ID кампании

Responses

Response samples

400
401
422
429

Content type

text/plain

Example

InvalidRcIdAdv

Некорректный ID РК

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

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

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

4 — одобрено
9 — приостановлена продавцом
11 — пауза по расходу бюджета

Максимум 5 запросов в секунду на один аккаунт продавца

Authorizations:

HeaderApiKey

query Parameters

id

required

integer

Example: id=1234

ID кампании

Responses

Response samples

400
401
422
429

Content type

text/plain

Example

InvalidRcIdAdv

Некорректный ID РК

Финансы

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

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

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

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

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

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

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

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

Максимум 1 запрос в секунду на один аккаунт продавца

Authorizations:

HeaderApiKey

Responses

Response samples

200
400
401
429

Content type

application/json

{"balance": 11083,
"net": 0,
"bonus": 15187
}

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

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

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

Максимум 4 запроса в секунду на один аккаунт продавца

Authorizations:

HeaderApiKey

query Parameters

id

required

integer

Example: id=1

ID кампании

Responses

Response samples

200
400
401
429

Content type

application/json

{"cash": 0,
"netting": 0,
"total": 500
}

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

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

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

Максимум 1 запрос в секунду на один аккаунт продавца

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

Payload

Content type

application/json

{"sum": 5000,
"type": 1,
"return": true
}

Response samples

200
400
401
429

Content type

application/json

Ответ при return=true

{"total": 500
}

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

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

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

Максимум 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

200
400
401
429

Content type

application/json

[{"updNum": 0,
"updTime": "2023-07-31T12:12:54.060536+03:00",
"updSum": 24,
"advertId": 3355881,
"campName": "лук лучок",
"advertType": 6,
"paymentType": "Баланс",
"advertStatus": 9
},
{"updNum": 0,
"updTime": null,
"updSum": 107,
"advertId": 3366882,
"campName": "золотая луковица",
"advertType": 8,
"paymentType": "Счет",
"advertStatus": 11
}
]

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

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

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

Максимум 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

200
400
401
429

Content type

application/json

[{"id": 1036666,
"date": "2022-02-04T09:06:47.985843Z",
"sum": 600,
"type": 0,
"statusId": 1,
"cardStatus": ""
},
{"id": 55261296,
"date": "2023-04-13T10:07:42",
"sum": 1500,
"type": 3,
"statusId": 1,
"cardStatus": "succeeded"
}
]

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

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

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

Управление активностью и установка/удаление фиксированных фраз.
Установка/удаление минус-фраз:
Получение и изменение списка карточек товаров в автоматических кампаниях.

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

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

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

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

Максимум 1 запрос в 500 миллисекунд на один аккаунт продавца

Authorizations:

HeaderApiKey

query Parameters

id required	integer Example: id=1234567 ID кампании
fixed	boolean Новое состояние (`false` - сделать неактивными, `true` - сделать активными)

Responses

Response samples

401
429

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 }}

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

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

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

Максимум 1 запрос в 500 миллисекунд на один аккаунт продавца

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

Payload

Content type

application/json

{"pluse": ["Фраза 1",
"Фраза 2"
]
}

Response samples

200
401
429

Content type

text/plain

[
  "Фраза 1",
  "Фраза 2"
]

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

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

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

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

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

Максимум 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

Payload

Content type

application/json

{"phrase": ["сло",
"гу"
]
}

Response samples

401
429

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.

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

Максимум 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

Payload

Content type

application/json

{"strong": ["стоять",
"лопата"
]
}

Response samples

401
429

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.

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

Максимум 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

Payload

Content type

application/json

{"excluded": ["что-то синее",
"картошечка"
]
}

Response samples

401
429

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 }}

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

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

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

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

Максимум 1 запрос в 6 секунд на один аккаунт продавца

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

Payload

Content type

application/json

Example

SettingMinusPhrase

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

{"excluded": ["первая фраза",
"вторая фраза"
]
}

Response samples

401
429

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 запрос в секунду на один аккаунт продавца

Authorizations:

HeaderApiKey

query Parameters

id

required

integer

Example: id=1

ID кампании

Responses

Response samples

200
401
429

Content type

text/plain

[
  1111111111,
  2222222222,
  3333333333,
  4444444444
]

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

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

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

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

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

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

Максимум 60 запросов в минуту на один аккаунт продавца

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

Payload

Content type

application/json

{"add": [11111111,
44444444
],
"delete": [55555555
]
}

Response samples

400
401
429

Content type

application/json

{"error": "Не найдено"
}

Медиа

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

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

Методы для получения данных кампаний ВБ.Медиа:

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

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

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

Максимум 10 запросов в секунду на один аккаунт продавца

Authorizations:

HeaderApiKey

Responses

Response samples

200
401
429

Content type

application/json

{"all": 6,
"adverts": [{"type": 2,
"status": 7,
"count": 2
},
{"type": 2,
"status": 8,
"count": 4
}
]
}

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

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

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

Максимум 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

200
401
429

Content type

application/json

[{"advertId": 123456,
"name": "тост",
"brand": "goosb",
"type": 2,
"status": 8,
"createTime": "2023-03-25T20:35:57.116943+03:00"
},
{"advertId": 54321,
"name": "тест",
"brand": "bobr",
"type": 1,
"status": 7,
"createTime": "2023-07-24T16:48:20.935599+03:00",
"endTime": "2023-07-25T20:35:50.104978Z"
}
]

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

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

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

Максимум 10 запросов в секунду на один аккаунт продавца

Authorizations:

HeaderApiKey

query Parameters

id

required

integer

Example: id=23569

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

Responses

Response samples

200
401
429

Content type

application/json

{"advertId": 23569,
"name": "Реклама денег принеси",
"brand": "Plank",
"type": 2,
"status": 11,
"createTime": "2023-07-19T11:13:41.195138+03:00",
"extended": {"reason": "Для возобновления показов пополните бюджет медиакампании",
"expenses": 10000,
"from": "2023-07-19T12:05:35.847348Z",
"to": "2123-07-20T08:14:13.079176+03:00",
"updated_at": "2023-07-21T13:25:31.129766+03:00",
"price": 0,
"budget": 0,
"operation": 1,
"contract_id": 0
},
"items": [{"id": 68080,
"name": "Унисон",
"status": 7,
"place": 2,
"budget": 650000,
"daily_limit": 500,
"category_name": "Главная",
"cpm": 351,
"url": "https://www.wildberries.ru/promotions/ssylka-na-akciyou",
"advert_type": 1,
"created_at": "2023-11-01T15:40:46.86165+03:00",
"updated_at": "2023-11-08T23:44:33.248229+03:00",
"date_from": "2023-11-01T16:05:22.286002Z",
"date_to": "2023-11-09T17:27:32.745869+03:00",
"nms": [123456,
11111111
],
"bottomText1": "string",
"bottomText2": "string",
"message": "string",
"additionalSettings": 1,
"receiversCount": 1,
"subject_id": 6945,
"subject_name": "Бельё",
"action_name": "Распродажа! Создай себе домашний уют!",
"show_hours": [{"From": 7,
"To": 8
}
],
"Erid": "string"
}
]
}

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

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

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

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

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

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

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

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

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

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

200
400
401
429

Content type

application/json

{"data": {"promotions": [{"id": 123,
"name": "скидки",
"startDateTime": "2023-06-05T21:00:00Z",
"endDateTime": "2023-06-05T21:00:00Z",
"type": "regular"
}
]
}
}

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

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

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

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

Authorizations:

HeaderApiKey

query Parameters

promotionIDs

required

string [ 1 .. 100 ] items unique

Example: promotionIDs=1&promotionIDs=3&promotionIDs=64

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

Responses

Response samples

200
400
401
429

Content type

application/json

{"data": {"promotions": [{"id": 123,
"name": "ХИТЫ ГОДА",
"description": "В акции принимают участие самые популярные товары 2023 года. Карточки товаров будут выделены плашкой «ХИТ ГОДА», чтобы покупатели замечали эти товары среди других. Также они будут размещены под баннерами на главной странице и примут участие в PUSH-уведомлениях. С ценами для вступления в акцию вы можете ознакомиться ниже.",
"advantages": ["Плашка",
"Баннер",
"Топ выдачи товаров"
],
"startDateTime": "2023-06-05T21:00:00Z",
"endDateTime": "2023-06-05T21:00:00Z",
"inPromoActionLeftovers": 45,
"inPromoActionTotal": 123,
"notInPromoActionLeftovers": 3,
"notInPromoActionTotal": 10,
"participationPercentage": 10,
"type": "auto",
"exceptionProductsCount": 10,
"ranging": [{"condition": "productsInPromotion",
"participationRate": 10,
"boost": 7
},
{"condition": "calculateProducts",
"participationRate": 20,
"boost": 17
},
{"condition": "allProducts",
"participationRate": 35,
"boost": 30
}
]
}
]
}
}

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

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

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

Данный метод неприменим для автоакций.

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

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

200
400
401
422
429

Content type

application/json

{"data": {"nomenclatures": [{"id": 162579635,
"inAction": true,
"price": 1500,
"currencyCode": "RUB",
"planPrice": 1000,
"discount": 15,
"planDiscount": 34
}
]
}
}

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

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

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

Данный метод неприменим для автоакций.

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

Authorizations:

HeaderApiKey

Request Body schema: application/json
required

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"promotionID": 1,
"uploadNow": true,
"nomenclatures": [1,
3,
642
]
}
}

Response samples

200
400
401
422
429

Content type

application/json

{"data": {"alreadyExists": false,
"uploadID": 11
}
}

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

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

Кампании

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

Authorizations:

Responses

Response samples

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

Authorizations:

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

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

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

Authorizations:

Responses

Response samples

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

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

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

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

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

Authorizations:

Responses

Response samples

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

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

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

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

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

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

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

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

Authorizations:

query Parameters

Responses

Response samples

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

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

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

Authorizations:

query Parameters

Responses

Response samples

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

Authorizations:

query Parameters

Responses

Response samples

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

Authorizations:

query Parameters

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required