バウチャーコードの作成
eSuite HQ管理画面にてオファー設定が行えるユーザーインターフェースをご用意しておりますが、お客様のシステムで顧客様用のバウチャーコード、リテンションインセンティブなどを生成必要な場合がございます。 このアクションはAPIを使用してeSuite HQへ外部的に処理することが出来ます。
概要
APIのメソッドとして、CreateVoucherCodeを既存のシステムにバウチャーコードの生成を統合できるようにeSuiteより提供しております。
使用例といたしまして、顧客がサブスクリプションをキャンセルする前に、システムが生成し、顧客にバウチャーコードを提供可能にする為です。 もしオファーがバウチャーの使用タイプに「ユーザー固有」がセットされていましたら、クライアントユーザーIDを特定の顧客アカウントへバウチャーコードをバインドする為に渡すことが出来ます。
詳細については、 「取得と変換」を参照してください。
リクエスト
C#
[csharp]
using (eDeveloperClient client = new eDeveloperClient())
{
var request = new CreateVoucherCodeRequest()
{
clientId = 433,
apiPassword = "sN?67oS=cE",
clientUserId = "20160106_433",
offerId = 1548
};
var response = client.CreateVoucherCode(request);
}
[/csharp]
{
var request = new CreateVoucherCodeRequest()
{
clientId = 433,
apiPassword = "sN?67oS=cE",
clientUserId = "20160106_433",
offerId = 1548
};
var response = client.CreateVoucherCode(request);
}
[/csharp]
リクエストパラメータ
次の表は、CreateVoucherCodeに提供する必要がある引数の一覧です。また、必須の引数も識別しております。
| 名称 | データー タイプ |
説明 | 必須か？ | 値の例 |
|---|---|---|---|---|
| ClientId | Integer | 支払いサービスが実装されている各WebサイトにMPPによって割り当てられます。これは、MPPアカウントマネージャーによって提供され、各加盟店に固有のものです。 | Yes | 433 |
| ApiPassword | String | 割り当てられたWebサービスのパスワード。 | Yes | sN?67oS=cE |
| ClientUserId | String | 顧客を識別する文字列。 | Yes | 547653 |
| OfferId | Integer | バウチャーコードに関連付けられるオファーのID。 | Yes | 728411 |