创建优惠券活动

Xsolla Developers

或

前往发布商帐户

创建优惠券活动Server-sideAdmin

post/merchants/{merchant_id}/coupon_promotions

创建一个新的优惠券活动。

注意

此API调用不包含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>

按照ISO 8601规定的YYYY-MM-DD’T’HH:MM:SS格式的活动到期日。

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 虚拟物品SKU。
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
}