CustomerSearchResult Document (Data API 17.1)

Document representing a customer search result.

Property Type Constraints Description
count Integer   The number of returned documents.
expand [String]   The list of expands set. Can be empty.
hits [CustomerSearchHit]   The sorted array of search hits. Can be empty.
next String   The URL of the next result page.
previous String   The URL of the previous result page.
query String   The requested query string.
query_args [String]   The query arguments.
select String   The fields that you want to select.
sort_string String   The sort string.
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.