対象プロモーション API
対象プロモーション API を使用して、顧客カートの対象となるプロモーションのリストを顧客に提供します。API では、取引先責任者、取引先、ロイヤルティプログラムメンバーの対象プロモーションのリストを取得できます。
必要なエディション
| 使用可能なインターフェース: Lightning Experience |
| 使用可能なエディション: リアルタイムオファー管理が付属する Enterprise Edition、Unlimited Edition、および Developer Edition |
カートの対象となるプロモーションのリストを顧客に提供します。API は顧客のカートの詳細を要求として受け取り、カートの対象の有効なプロモーションの詳細を応答として提供します。品目の対象プロモーションを検索する場合、API は商品のカテゴリ階層の 5 レベルをスキャンします。
Salesforce カタログに存在しない商品がカートに含まれている場合、API は品目レベルおよびクロス品目レベルのプロモーションを評価するときに同期されていない商品を無視し、カートの対象プロモーションを表示します。
組織に複数のグローバルプロモーション管理種別のルールライブラリがある場合、システムインテグレーターは API で実行するルールライブラリを指定する必要があります。また、ルールライブラリのコンテキスト定義でカートを評価するために必要な値が API の要求に含まれていることも確認する必要があります。
API 応答では、次のプロモーションの詳細が提供されます。
- 開始日や終了日など、プロモーションの主要な詳細
- プロモーションのカスタム項目値
- プロモーションの制限
- 顧客のカートの対象となるプロモーションのルール
- プロモーションコンテキスト定義で対応付けられているプロモーションのカスタム項目値。
顧客に対象プロモーションをリアルタイムで提供するには、対象プロモーション API を顧客カートを管理する外部システムと統合します。「対象プロモーション」を参照してください。
プロモーションの使用量が特定のカートのプロモーションの制限を満たすと、対象プロモーション API は API 出力でどの顧客にも報奨を提供しません。顧客の報奨使用量がプロモーションの顧客レベルの制限を満たすと、対象プロモーション API は顧客に報奨を提供しなくなります。
Cloud Kicks のオンラインショッピングサイトから対象プロモーション API を実行したときの要求は次のようになります。
{
"cart":{
"Accessory":[
{
"activityStartDate":"2023-06-14T12:45:19Z",
"contactId":"003xx000004WjzAAAS",
"transactionAmount":85,
"currencyISOCode":"INR",
"cartLineDetails":[
{
"CartLineProductCategory":"Sneaker Shields",
"cartLineProductCatalogId:"0ZSSB0000002d8X4AQ"",
"AttributeKey:"Premium"
}
]
}
]
}
}クーポンを使用したプロモーションの対象プロモーション API
クーポンがプロモーションに追加されると、対象プロモーション API は顧客のカートの詳細を要求として受け取り、顧客のカートの対象となるプロモーションの有効なクーポンの詳細で応答します。顧客は、カートに適用するプロモーションのクーポンを使用できます。
クーポンが含まれる対象プロモーションの場合、API の応答には次のクーポンの詳細が含まれます。
- クーポンコード
- 開始日と終了日
- 状況
API は、顧客の活動日に 1 つ以上の有効なクーポンがあるプロモーションのみを返します。プロモーションは複数のクーポンで構成できますが、次のシナリオでは API にクーポンコードは表示されません。
- 活動日の対象となる有効なクーポンが複数ある場合
- 活動日に有効なクーポンがない場合
- 対象の有効なクーポンが利用制限に達した場合
