Commerce Webstore Product Search

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

リソース

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

使用可能なバージョン

49.0

Chatter が必要かどうか

いいえ

HTTP メソッド

POST

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

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  "page" : 0,
21  "pageSize" : 25}

プロパティ

名前	型	説明	必須か省略可能	使用可能なバージョン
categoryId	String	カテゴリ ID は、このカテゴリまたはそのサブカテゴリの商品の結果を返します。	searchTerm が指定されていない場合は必須	49.0
fields	String[]	検索結果で返される商品項目。検索結果には、アクセス権のある項目が含まれます。指定しない場合、アクセスできるすべての項目が返されます。	省略可能	49.0
includePrices	Boolean	検索結果に商品の価格を含めるか (true)、否か (false) を指定します。指定しない場合は、デフォルトの false になります。	省略可能	49.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

POST の要求パラメータ

パラメータ名	型	説明	必須か省略可能	使用可能なバージョン
effective​AccountId	String	要求が行われた取引先の ID。 指定しない場合、デフォルトで、コンテキストユーザの accountID になります。	省略可能	49.0

POST のレスポンスボディ

Product Search Results