j1.0.39
API の概要
Shopper Products API を使用すると、オンラインであり、特定のサイトカタログ向けにマーチャンダイズされ、販売の準備ができている商品の商品詳細にアクセスできます。この商品情報を使って、他の eコマースチャネルで商品をマーチャンダイジングできます。他のコマースアプリやストアフロントでカテゴリのナビゲーションパスを設定するには、Categories API を使用します。
Shopper Products API ではキャッシュを利用できます。詳細については、サーバー側の Web 階層キャッシングを参照してください。
認証と認可
商品情報をリクエストするクライアントは、Products リソースへのアクセス権が必要です。Shopper Products API には、Shopper Login and API Access Service (SLAS) の買い物客アクセストークンが必要です。
SLAS から買い物客アクセストークンをリクエストする方法の詳細については、SLAS ガイドのパブリッククライアントとプライベートクライアントのゲストユーザーフローを参照してください。
ユースケース
商品一覧ページの設定
Shopper Product API を使用して、Commerce Cloud API を使用して構築されたコマース買い物アプリで閲覧している顧客が、商品のリストを表示できるようにします。たとえば、商品のリスト (最大 24 個) のハイドレーションを行います。この API は、画像、価格、プロモーション、商品の入手可能性など、商品の詳細を返します。
eコマースチャネルでのバリエーション商品詳細の取得
この API を使用して、Commerce Cloud API を使用して構築されたコマース買い物アプリで閲覧している顧客が、異なるバリエーション商品を切り替えられるようにします。API によって、画像、価格、キャンペーン、販売可能在庫など、商品の詳細が返されます。
プロモーション情報の取得
プロモーションでは、買い物客が特定の購入要件を満たした場合に割引が提供されます。
プロモーション情報の詳細についてはプロモーションの詳細を参照してください。また、次のリストにはいくつかの重要なポイントがあります。
- 買い物カゴプロモーションと配送プロモーションの価格割引は、'getProduct' エンドポイントまたは 'getProducts' エンドポイントでは返されません。
- プロモーション価格は、非条件付きプロモーションに含まれる商品の場合にのみ返されます。
- コールアウトメッセージは、'getProduct' エンドポイントと 'getProducts' エンドポイントで常に返されます。
デフォルトでは、'getProduct' と 'getProducts' はクエリ対象の商品のプロモーション情報を返します。プロモーション情報には、価格情報とコールアウトメッセージ情報の両方が含まれます。ただし、取得される特定の価格設定とコールアウトの情報は、以下によって決定されます。
- プロモーションタイプ
- 商品タイプ
- 商品購入要件
商品詳細ページ (PDP) または商品一覧ページ (PLP) に表示できるプロモーションもあれば、「商品を買い物カゴに追加して価格情報を表示」という注文レベルのプロモーションなど、買い物カゴのコンテキストで表示されるプロモーションもあります。SCAPI 上で PDP または PLP を設計する際には、レスポンスに何が含まれているかを理解し、設計が実装可能な機能と一致していることを確認することが重要です。
買い物客向けパーソナライズ
SCAPI レスポンスは、Shopper Context API またはフックを使用してパーソナライズできます。Shopper Context API で特定の値を設定することで、買い物客のコンテキストに基づいて 'getProduct' エンドポイントまたは 'getProducts' エンドポイントのレスポンスを変更できます。たとえば、モバイルデバイスを使用する買い物客に 5% 割引や送料無料を提供できます。
JWA キャッシュ
レスポンスは JWA でキャッシュされます。つまり、レスポンスに含まれるプロモーションデータも、Business Manager の機能スイッチの構成で指定されている TTL (Time to Live) に基づいてキャッシュされます。 買い物客のコンテキスト値が更新されると、更新された買い物客のコンテキストが商品プロモーションデータの取得に影響するかどうかがチェックされます。影響する場合、レスポンスはソースからフェッチされ、JWA にキャッシュされます。
詳細については、サーバー側の Web 階層キャッシングを参照してください。
フックの使用
フックの使用方法の詳細については、フックによる拡張性を参照してください。
リソース
商品
マーチャンダイジングする商品やサービスを完全に表現するもの。マーチャンダイジング可能商品とは、オンラインで、分類されていて、チャネルに公開された商品のことです。商品に関する情報には、商品名、説明、カスタム属性、システム属性、バリエーション、価格、在庫、画像などが含まれます。
カテゴリ
カテゴリとサブカテゴリは、カタログやストアフロントで商品を整理し、グループ化するための構造です。カテゴリは、他のカテゴリとの関係をもつことができます。さらに、各カテゴリは、サブカテゴリが継承するコンテキストを提供できます。たとえば、カテゴリには属性を割り当てることができます。そのカテゴリやサブカテゴリに割り当てられた商品は、カテゴリの属性値を継承します。商品がカテゴリから削除されると、その属性値は商品に継承されなくなります。また、サイトの階層的なナビゲーションとして、カテゴリリンクを使用できます。たとえば、「Clothing」カテゴリの中に「Mens」があり、「Mens」カテゴリの中に「Pants」があるなどが考えられます。
カテゴリはタグではありません。
エンドポイント
GET /products
1 回の API リクエストで最大 24 商品の商品詳細が返されます。この API は、商品一覧ページへの情報投入など、複数の商品を一度に入力またはハイドレートする必要があるユースケースで使用できます。
レスポンスデータには、リクエストされた商品の基本的な商品情報とともに、入手可能性、プロモーション、画像、価格などが含まれています。
GET /products/{id}
1 つの商品に関する商品詳細が返されます。この API は、商品詳細ページへの情報投入など、1 つの商品を一度に入力またはハイドレートする必要があるユースケースで使用できます。
レスポンスデータには、リクエストされた商品の入手可能性、プロモーション、オプション、画像、価格、バリエーション、bundled_products、set_products、おすすめ、基本商品情報などが含まれています。
GET /categories
1 つまたは複数のカテゴリの上位下位関係を含む、カテゴリの詳細が返されます。上位下位関係の深さの上限は 2 です。
Let us know so we can improve!