メインコンテンツへスキップ
プロモーションコードは、既存のクーポンに対して購入者が入力できる別のコードです。クーポンの割引が適用されます。クーポンの制限は有効期限と合計使用回数のみで、購入者の制限はプロモーションコードごとに設定します。インフルエンサーやキャンペーンごとのコード、使い切りコードの一括発行などに利用できます。 プロモーションコードは active のクーポンに対してのみ作成でき、クーポンと同じストア・同じ環境に属します。プロモーションコードを作成しても、クーポンの割引内容は変わりません。

プロモーションコードのステータス値

制限

プロモーションコードはそれぞれ独自の購入者制限を持ちます。クーポンの redeemBy と maxRedemptions もすべてのコードに適用されます: プロモーションコードはクーポンと一緒に作成するか(クーポンの作成、最大 20 個)、以下のエンドポイントで 1 つずつ、または一括で作成します。クーポン自身の code はプロモーションコードには含まれません。独自の制限はなく、promotionCodes では返されず、クーポンと一緒にのみ無効化できます。

コード

プロモーションコードはクーポンと同じコード形式に従います。英字・数字・- の 3–32 文字で、大文字・小文字を区別せず大文字で保存され、同じストア・同じ環境の有効なコードの中で一意であり、無効化すると解放されます。code を省略した場合や一括生成の場合、ランダム部分は大文字の英字と数字で構成され、紛らわしい 0、O、1、I、L は使用されません。

安全なリトライ

X-Idempotency-Key ヘッダー(SDK では idempotencyKey オプション)を送信し、リトライ時も同じキーを使ってください。特にプロモーションコードの一括生成では重要です。コードはランダムに生成されるため、キーなしでリトライすると 2 つ目のバッチが生成されます。キーの要件はエラーを参照してください。

プロモーションコードの取得

これらのエンドポイントは書き込み専用です。クーポンのプロモーションコードは GraphQL の promotionCodes と promotionCodesCount で取得します。batchId で絞り込むと、生成したバッチを再取得できます。

エンドポイント

プロモーションコードの作成

クーポンにプロモーションコードを 1 つ追加します。

プロモーションコードの一括生成

1 回の呼び出しで 1–500 個のランダムなプロモーションコードを生成します。

プロモーションコードの無効化

プロモーションコードを完全に無効化し、コードを解放します。