PublishedProductSearchHit
Represent a search hit
This page contains
Fields
| documentId: ID | Document id in search index. |
| documentScore: Decimal | Document score. |
| documentScoreExplanation: JSON | Document score explanation. |
| productId: ID | AppDirect product id |
| productUuid: ID | AppDirect product uuid |
| productRefId: ID | AppDirect product ref id |
| productName: String | AppDirect product name |
| productListingImageUrl: URL | AppDirect product listing image url |
| rank: Int | AppDirect marketplace product sort rank |
| source: JSON @deprecated( reason: "Internal field; prefer explicit hit fields. Will be removed in a future version." ) | Source document in search index. |
| highlights: [PublishedProductSearchFieldHighlight] | highlights of portion of text in a product document that matches the a search term |
| matchedEditions: [PublishedProductSearchMatchedEdition] PREVIEW | List of editions that matched the search query |
Parent objects of PublishedProductSearchHit
| PublishedProductSearchResult | Represent a search result |
| PublishedProductSearchResultTesting | Represent a search result |
| PublishedProductSuggestResult | Represent a suggest search result for typeahead |
| ResellerPublishedProductSearchResult PREVIEW | Represent a Reseller search result |
| SalesAgentPublishedProductSearchResult PREVIEW | Represent a Sales Agent search result |
Queries for PublishedProductSearchHit
| publishedProductsSearch | Returns a paginated list of published products that match the queryString, partner, locale and filters provided. |
| publishedProductsSearchSuggest | Returns product suggestions for typeahead search based on the queryString, locale and filters provided. |
| publishedProductsSearchTesting | Returns a paginated list of published products that match the queryString, partner, locale and filters provided (testing variant with explainScore and esQuery). |
| resellerPublishedProductsSearch PREVIEW | Returns a paginated list of published products for a given Reseller that match the queryString, partner, locale and filters provided. |
| salesAgentPublishedProductsSearch PREVIEW | Returns a paginated list of published products for a given Sales Agent that match the queryString, partner, locale and filters provided. |