Commerce Webstore Product Search

商品の検索ではバイヤーの「商品を表示」エンタイトルメントが適用され、商品データを表示する資格があるユーザのみがこのリソースにアクセスできます。

リソース

使用可能なバージョン

49.0

Chatter が必要かどうか

いいえ

HTTP メソッド

POST

通常、POST メソッドは項目を作成しますが、このリソースでは POST を使用して情報を取得します。

POST のリクエストボディ

JSON の例

プロパティ

名前	型	説明	必須か省略可能	使用可能なバージョン
categoryId	String	カテゴリ ID は、このカテゴリまたはそのサブカテゴリの商品の結果を返します。	searchTerm が指定されていない場合は必須	49.0
fields	String[]	検索結果で返される商品項目。検索結果には、アクセス権のある項目が含まれます。指定しない場合、アクセスできるすべての項目が返されます。	省略可能	49.0
grouping	Product Search Grouping Input	検索結果の商品をグループ化するかどうかと、グループ化する方法を指定します。指定しない場合、デフォルトは [検索] | [結果表示設定] | [結果のグループ化] で指定した値です。	省略可能	51.0
includePrices	Boolean	検索結果に商品の価格を含めるか (true)、否か (false) を指定します。指定しない場合は、デフォルトの false になります。	省略可能	49.0
includeQuantity​Rule	Boolean	検索結果に商品の購入数量ルール情報を含めるか (true)、否か (false) を指定します。指定しない場合は、デフォルトの false になります。	省略可能	52.0
page	Integer	返すページのページ番号を指定します。0 から開始します。値を指定しないか 0 を指定した場合、最初のページが返されます。	省略可能	49.0
pageSize	Integer	ページあたりの項目数を指定します。有効な値は 1 ～ 200 です。指定しない場合、デフォルトは [検索] | [結果表示設定] | [結果表示の上限] の [ページあたりの結果数] で指定した値です。	省略可能	49.0
refinements	Distinct Value Refinement Input[]	検索結果の絞り込み。	省略可能	49.0
searchTerm	String	スペースで区切られた最大 32 個の検索語のリスト。	categoryId が指定されていない場合は必須	49.0
sortRuleId	String	検索結果の商品の順序を指定する並び替えルールの ID。	省略可能	52.0

POST の要求パラメータ

パラメータ名	型	説明	必須か省略可能	使用可能なバージョン
effective​AccountId	String	要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。 指定されていない場合、デフォルト値はコンテキストから決定されます。	省略可能	49.0

POST のレスポンスボディ

Product Search Results