Salesforce B2C Commerce 24.7 > Open Commerce API 23.2 > Data API documents 23.2

SearchRequest document (Data API 23.2)

Document representing a search request for retrieving items within the Data API. The query is a potentially complex set of expressions. The fields that each query supports are defined within the search resource.

Property Type Constraints Description
count Integer maxIntegerValue=200, minIntegerValue=1 The number of returned documents
db_start_record_ Integer minIntegerValue=0 The zero-based index of the record that we want to start with, used to optimize special handling
expand [String]   List of expansions to be applied to each search results. Expands are optional
query Query {BoolQuery, FilteredQuery, MatchAllQuery, NestedQuery, TermQuery, TextQuery} mandatory=true, nullable=false The query to apply
select String   The field to be selected.
sorts [Sort]   The list of sort clauses configured for the search request. Sort clauses are optional.
start Integer minIntegerValue=0 The zero-based index of the first search hit to include in the result.

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.