プロモーションコードは、お客様がクーポンと引き換えることができるコードです。1つのクーポンに対して複数のコードを作成することができ、正常に引き換えられると、注文にクーポンの割引が追加されます。
属性
- id文字列
- オブジェクトの一意の識別子です。
- object文字列 (値は promotionCode)
- オブジェクトの種類を表す文字列です。同じ種類のオブジェクトの場合は同じ値を共有します。
- activeブール値
- プロモーションコードが現在有効かどうかを示すフラグです。
- code文字列
- お客様に表示されるコードです。すべてのプロモーションコードが一意である必要があります。
- createdAtタイムスタンプ
- オブジェクトが作成された時間です。Unix エポックからのミリ秒数で表されます。
- currency文字または空値
minimumAmountが設定されている場合は、大文字3文字の ISO 通貨コードです。サポートされている通貨である必要があります。- expiresAtタイムスタンプまたは空値
- プロモーションコードが利用できなくなる時間です。Unix エポックからのミリ秒で表されます。
- firstTimeTransactionブール値
- 加盟店様のお店でこれまで一度も Smartpay での支払いを行っていないお客様しか利用できないプロモーションコードであることを示すフラグです。
- maxRedemptionCount正の整数または空値
- 当該のプロモーションコードを利用できるお客様全体での最大の合計回数です。
- metadataオブジェクト
- キーと値のペアで、オブジェクトにアタッチし、追加情報を構造化された形式で保存することができます。
- minimumAmount正の数値または空値
- 当該のプロモーションコードを利用するために必要な最低金額です (プロモーションコードを適用するには注文金額が ¥10,000 以上でなければならないなど)。
- onePerCustomerブール値
- 当該のプロモーションコードはお客様一人につき一回しか利用できないことを示すフラグです。
- redemptionCount正の整数
- 当該のプロモーションコードが利用された回数です。
- testブール値
- オブジェクトが、ライブモードの場合は
falseのフラグ、テストモードの場合はtrueのフラグです。 - updatedAtタイムスタンプ
- オブジェクトが最後に更新された時間です。Unix エポックからのミリ秒数で表されます。