CustomerSearchRequest Document (Data API 17.2)
Document representing a customer search request.
Property | Type | Constraints | Description |
---|---|---|---|
count
|
Integer | maxIntegerValue=200, minIntegerValue=1 | The count of search hits to include in the result. |
expand
|
[String] | The list of expands set for the search request. Expands are optional. | |
query
|
String | mandatory=true, nullable=false | 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. |
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.