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

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

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 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": "elven_sword"
}
],
"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"
}