この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

Commerce Webstore Product Search

商品を検索します。

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

リソース

1/commerce/webstores/webstoreId/search/product-search

使用可能なバージョン

49.0

Chatter が必要かどうか

いいえ

HTTP のメソッド

POST

通常、POST メソッドは項目を作成しますが、このリソースでは POST を使用して情報を取得します。POST と GET のどちらでも同じ情報が取得されます。ただし、GET コールはキャッシュされる場合があります。

POST のリクエストボディ

JSON の例

1{
2  "searchTerm": "lightweight",
3  "categoryId": "0ZGxx000000006TGAQ", //categoryId for women’s running shoes
4  "refinements": [
5   {  
6      "attributeType": "Custom",
7      "nameOrId": "Color__c",
8      "values": ["red", "blue"],
9      "type": "DistinctValue"
10   },
11   {  
12
13      "attributeType": "Custom",
14      "nameOrId": "Size__c",
15      "values": ["5"],
16      "type": "DistinctValue"
17   }
18  ],
19  "fields": ["Name", "Description", "StockKeepingUnit", "Size__c", "Arch__c"],
20  "grouping": {
21     "groupingOption": "VariationParent"
22  }
23  "page" : 0,
24  "pageSize" : 25}

プロパティ

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

POST の要求パラメータ

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

POST のレスポンスボディ

Product Search Results

Connect REST API 開発者ガイド

Commerce Webstore Product Search