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

Xsolla Developers

или

Создание кампанииServer-sideAdmin

post/merchants/{merchant_id}/coupon_promotions

Создайте новую купонную кампанию.

Внимание

Этот метод API не включает в себя path-параметр project_id, поэтому для авторизации вам необходимо использовать ключ API, который действует во всех проектах.

SecuritybasicAuth

Request

path Parameters

merchant_id

required

integer

ID продавца.

Request Body schema: application/json

campaign_code

required

string

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

project_id

required

integer

ID проекта.

required

object

Объект с локализованными названиями кампании.

ar	string Арабский.
bg	string Болгарский.
cn	string Китайский упрощенный.
cs	string Чешский.
de	string Немецкий.
en	string Английский.
es	string Испанский.
fr	string Французский.
he	string Иврит.
it	string Итальянский.
ja	string Японский.
ko	string Корейский.
pl	string Польский.
pt	string Португальский.
ro	string Румынский.
ru	string Русский.
th	string Тайский.
tr	string Турецкий.
tw	string Китайский традиционный.
vi	string Вьетнамский.

campaign_redeems_count_for_user

integer

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

expiration_date

string <datetime>

Дата окончания кампании в формате YYYY-MM-DD’T’HH:MM:SS согласно стандарту ISO 8601.

redeems_count

integer

Максимальное количество погашений купона. Если передан null, количество погашений не ограничено.

redeems_count_for_user

integer

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

object

Объект с параметрами подписки в вознаграждении.

plan_id required	integer ID плана подписки.
product_id required	integer ID продукта подписки.
trial_period required	integer Продолжительность пробного (триального) периода в днях.

virtual_currency_amount

number <float>

Количество виртуальной валюты в вознаграждении.

object

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

sku required	string Артикул виртуального предмета.
quantity required	integer Количество виртуальных предметов.

Responses

201

Created.

Request samples

application/json

{"campaign_code": "sample_campaign",
"campaign_names": {"en": "Campaign Name",
"ru": "Название кампании"
},
"campaign_redeems_count_for_user": 1,
"expiration_date": "2019-12-31",
"project_id": 12345,
"redeems_count": 10,
"redeems_count_for_user": 1,
"subscription_coupon": {"plan_id": 123,
"product_id": 456,
"trial_period": 30
},
"virtual_currency_amount": 200
}

Response samples

application/json

{"id": 9134
}