Xsolla-logo
  • 文档
  • 创建帐户

创建促销码活动Server-sideAdmin

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

创建促销码活动。

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 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_endnull,则促销活动无时间限制。

date_start
string or null <date-time>
Default: "2020-04-15T18:16:00+05:00"

促销活动开始日期。

object or null
percent
string or null
Default: "10.00"

百分比折扣。 购物车价格将按照此百分比打折,然后四舍五入到小数点后两位。

Array of objects or null

通过促销码打折的商品列表。

Array
sku
required
string
Default: "elven_shield"

商品SKU。

required
object
percent
required
string
Default: "10.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
{
  • "bonus": [
    ],
  • "date_end": "2020-04-15T18:16:00+05:00",
  • "date_start": "2020-04-15T18:16:00+05:00",
  • "discount": {
    },
  • "discounted_items": [
    ],
  • "external_id": "coupon_external_id",
  • "name": {
    },
  • "redeem_code_limit": 10,
  • "redeem_total_limit": 10,
  • "redeem_user_limit": 10
}
Response samples
application/json
{
  • "external_id": "coupon_external_id"
}