GenericSearch APIを使った商取引エンティティのSearch

Sitecore Experience Commerce SDKにはPostmanのSearchApiSamplesコレクションの一部としてGenericSearch APIコマンドが含まれています。サンプルリクエストを使って、インデックス化されたコマースエンティティをCommerce Engineで検索できます。SearchプラグインはGenericSearch APIエンドポイントをGeneric Search Frameworkの一部として定義しています。GenericSearchクエリは、検索提供者に依存しない構文で構築します。カタログアイテム、プロモーション、注文、価格表、または顧客を検索できます。

以下の手順は、Postmanアプリケーションをインストールし、Sitecore Commerce Engine SDKからサンプルコレクションを取り込み、環境を設定し、Commerce Engine APIにアクセスするためのベアラートークンを取得したことを前提としています(ここで説明しています)。

カタログ項目などのコマースエンティティをGenericSearchサンプルで検索するには:

1. PostmanコレクションのパネルでSearchAPISamplesコレクションを展開します。 

2. APIフォルダを開き、POST GenericSearchリクエスト({{ServiceHost}}/{{ShopsApi}}/GenericSearch())をクリックします。

3. Bodyタブをクリックし、検索クエリのパラメータを更新して検索クエリを構築してください。以下の例は、名前「InstaClix Instant Film Camera」に合致する販売可能な商品をサンプルHabitat_Masterカタログから検索するために作成されたクエリを示しています。

   { "searchScope": "-CatalogItemsScope", "searchQuery": null, "filterQuery": { "FilterNode": { "@odata.type": "#Sitecore.Commerce.Plugin.Search.EqualsFilterNode", "FieldName": { "@odata.type": "#Sitecore.Commerce.Plugin.Search.FieldNameFilterNode", "Name": "name" }, "FieldValue": { "@odata.type": "#Sitecore.Commerce.Plugin.Search.FieldValueFilterNode", "Value": "Habitat_Master", "ValueType": "1" } } }, "searchOptions": { "Skip": "0", "Top": "3", "ResultsOrderFields": , "FieldsToRetrieve": } }

4. Sendをクリックします。以下は検索結果の一例です。

   {   "@odata.context": "https://cqa-dem-01-dk1:5000/api/$metadata#Collection(Sitecore.Commerce.Plugin.Search.SearchResult)",   "value":       {        "Fields":        {              "Key": "sitecoreid", "Value": "46455327-796c-8125-b838-f6d7f678303d"           },           {             "Key": "entityuniqueid",     "Value": "6d737cc2-333b-ae32-73f0-cc3d67631409"           },           {             "Key": "entityid",             "Value": "Entity-SellableItem-7042066"           }, { "Key": "entityversion",             "Value": "1" },           {    "Key": "productid",               "Value": "7042066"            },             {             "Key": "displayname",             "Value": "InstaClix Instant Film Camera"           },           {            "Key": "name", "Value": "InstaClix Instant Film Cmera"           },     {            "Key": "datecreated",              "Value": "5/16/2019 `2

   `
    PM +`00
   `"           },           {              "Key": "dateupdated",              "Value": "2/29/2020 `10
   `
    AM +`00
   `"           },           {              "Key": "artifactstoreid",             "Value": "78a1ea61-1f37-42a7-ac89-9a3f46d60ca5"           },        {         "Key": "parentcataloglist",              "Value": "\"59ddadc1-9b88-727e-9e14-3f6cf321ae0f\""           },           {              "Key": "variantid", "Value": "57042066|57042067|57042068| 57042069|57042070"           },           {           "Key": "variantdisplayname", "Value": "InstaClix Instant Film Camera (Blue)|InstaClix Instant Film Camera (Red)| InstaClix Instant Film Camera (Green)|InstaClix Instant Film Camera (Teal)|InstaClix Instant Film Camera (Pink)"            },            {               "Key": "inventorysetids",                "Value": "Entity-InventorySet-Habitat_Inventory"             },            {              "Key": "_version_",                "Value": "1659868448064274437"            }               }   }

!注 汎用検索フレームワーク は、クエリを構築するために使える検索およびフィルターのノード、条件、演算子を定義します。