创建优惠券促销活动

Xsolla Developers

或

前往发布商帐户

创建优惠券促销活动Server-sideAdmin

post/v2/project/{project_id}/admin/coupon

创建优惠券促销活动。

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

项目编号。您可以在您的发布商帐户项目名称旁边。

Example: 44056

Request Body schema: application/json

external_id

required

string

Default: "coupon_external_id"

唯一促销活动ID。 external_id只能包含小写英文字母和数字字符、句点、破折号和下划线。

required

object

Default: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}

促销活动名称。应包含键/值对，其中键是"^[a-z]{2}-[A-Z]{2}$"格式的区域设置，值是字符串。

property name*

additional property

string

Array of type = string (objects) or Array of type = date (objects) or Array of type = number (objects)

与用户属性值进行比较的条件。必须满足所有条件操作才生效。

One of:

与用户属性值进行比较的条件。必须满足所有条件操作才生效。

[ 1 .. 100 ] items

Array ([ 1 .. 100 ] items)

attribute

required

string [ 1 .. 255 ] characters ^[-_.\\d\\w]+$

用户属性代码。

operator

required

string

按条件执行的操作类型。用于string属性类型。

Enum:	Description
eq	等于
ne	不等于

value

required

string <= 255 characters

与用户属性值进行比较的条件值。类型取决于属性类型。

type

required

string

用户属性类型。

Value: "string"

can_be_missing

boolean

表示即使用户属性中缺少属性仍满足条件。传递true可向不具有此属性的用户显示该项目。具有该属性但值与条件中指定的值不匹配的用户将看不到该商品。传递false则具有该属性但值与条件中指定的值不匹配或缺少该属性的用户将看不到该商品。

Array of objects or null

Array

quantity	number Default: 1 商品数量。
sku	string Default: "elven_shield" 商品SKU。

date_end

string or null <date-time>

Default: "2020-04-15T18:16:00+05:00"

促销活动结束日期。可以是null。如果date_end 为null，则促销活动无时间限制。

date_start

string or null <date-time>

Default: "2020-04-15T18:16:00+05:00"

促销活动开始日期。

redeem_code_limit

integer or null

Default: 10

每个代码的兑换次数。

redeem_total_limit

integer or null

Default: 10

限制优惠券的总数。

redeem_user_limit

integer or null

Default: 10

限制单个用户兑换的优惠券总数。

Responses

201

优惠券已成功创建。

401

基本认证未通过或错误。确保您使用了基本认证或正确的凭据。

422

无效的请求。

Request samples

application/json

{"attribute_conditions": [{"attribute": "account_status",
"can_be_missing": false,
"operator": "eq",
"type": "string",
"value": "golden"
}
],
"bonus": [{"quantity": 1,
"sku": "com.xsolla.elven_sword_2"
}
],
"date_end": "2020-04-25T18:16:00+05:00",
"date_start": "2020-04-15T18:16:00+05:00",
"external_id": "coupon_external_id",
"name": {"de-DE": "Neujahrsbonus",
"en-US": "New Year Bonus"
},
"redeem_code_limit": 1,
"redeem_total_limit": 100,
"redeem_user_limit": 1
}

Response samples

application/json

{"external_id": "coupon_external_id"
}