Xsolla-logo

クーポンプロモーションを作成

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

クーポンプロモーションを作成します。

SecuritybasicAuth
Request
path Parameters
project_id
required
integer

プロジェクトID。このパラメータは、ドメインページのプロジェクト名の横にあります。

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"

プロモーションを開始する日付。

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",
  • "external_id": "coupon_external_id",
  • "name": {
    },
  • "redeem_code_limit": 10,
  • "redeem_total_limit": 10,
  • "redeem_user_limit": 10
}
Response samples
application/json
{
  • "coupon_id": "coupon_external_id"
}