Connect REST API 開発者ガイド
jCommerce Webstore Search Products
- リソース
-
1/commerce/webstores/webstoreId/search/products - 使用可能なバージョン
- 58.0
- HTTP のメソッド
- GET
- GET の要求パラメータ
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン categoryId String カテゴリ ID は、このカテゴリまたはそのサブカテゴリの商品の結果を返します。 searchTerm が指定されていない場合は必須 58.0 effectiveAccountId String 要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。指定されていない場合、デフォルト値はコンテキストから決定されます。 省略可能 58.0 fields String[] 検索結果で返される商品項目。検索結果には、アクセス権のある項目が含まれます。 必須 58.0 grouping String 検索結果のグルーピングオプション。指定しない場合、デフォルトは で指定した値です。値は次のとおりです。 - NoGrouping — 検索結果はグループ化されません。
- VariationParent — 検索結果はバリエーションの親でグループ化されます。
省略可能 58.0 includeQuantityRule Boolean 検索結果に商品の購入数量ルール情報を含めるか (true)、否か (false) を指定します。指定しない場合は、デフォルトの false になります。 省略可能 58.0 page Integer 返すページの数。0 から開始します。値を指定しないか 0 を指定した場合、最初のページが返されます。
省略可能 58.0 pageSize Integer ページあたりの項目数を指定します。有効な値は 1 ～ 200 です。指定しない場合は、デフォルトの 20 になります。
page プロパティ値と pageSize プロパティ値を乗じた場合、その値が 5000 を超えることはできません。たとえば、pageSize が 20 の場合、page 値に指定できるのは 250 までになります。
省略可能 58.0 refinements String 検索結果の絞り込み (ファセット) を最大 9 項目表示するリスト。バイヤーや買い物客は、絞り込みごとに最大 20 個の値を選択できます。refinements パラメータは、JSON 表現の Distinct Value Refinement Input から Base64 文字列としてエンコードされます。 省略可能 58.0 searchTerm String スペースで区切られた最大 32 個の検索語のリスト。 categoryId が指定されていない場合は必須 58.0 sortRuleId String 検索結果の商品の順序を指定する並び替えルールの ID。指定されていない場合、デフォルトの並び替え種別は関連性です。 省略可能 58.0 - GET のレスポンスボディ
- Commerce Product Search Results