ProductSearchResult Document (Shop API 17.2)

Document representing a product search result.

Property Type Constraints Description
count Integer   The number of returned documents.
hits [ProductSearchHit]   The sorted array of search hits. This array can be empty.
next String   The URL of the next result page.
previous String   The URL of the previous result page.
query String   The query String that was searched for.
refinements [ProductSearchRefinement]   The sorted array of search refinements. This array can be empty.
search_phrase_suggestions Suggestion   The suggestion given by the system for the submitted search phrase.
select String   The fields that you want to select.
selected_refinements Map[String, String]   A map of selected refinement attribute id/value(s) pairs. The sorting order is the same as in request URL.
selected_sorting_option String   The id of the applied sorting option.
sorting_options [ProductSearchSortingOption]   The sorted array of search sorting options. This array can be empty.
start Integer minIntegerValue=0 The zero-based index of the first search hit to include in the result.
total Integer   The total number of documents.

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.

X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.